Skip to content

Commit 0038cb7

Browse files
committed
feat: website
1 parent 534e448 commit 0038cb7

File tree

5 files changed

+55
-3
lines changed

5 files changed

+55
-3
lines changed

.Rbuildignore

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
^_pkgdown\.yml$
55
^docs$
66
^pkgdown$
7+
^\.github$

.github/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

.github/workflows/pkgdown.yaml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
release:
9+
types: [published]
10+
workflow_dispatch:
11+
12+
name: pkgdown
13+
14+
permissions: read-all
15+
16+
jobs:
17+
pkgdown:
18+
runs-on: ubuntu-latest
19+
# Only restrict concurrency for non-PR jobs
20+
concurrency:
21+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
22+
env:
23+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
24+
permissions:
25+
contents: write
26+
steps:
27+
- uses: actions/checkout@v4
28+
29+
- uses: r-lib/actions/setup-pandoc@v2
30+
31+
- uses: r-lib/actions/setup-r@v2
32+
with:
33+
use-public-rspm: true
34+
35+
- uses: r-lib/actions/setup-r-dependencies@v2
36+
with:
37+
extra-packages: any::pkgdown, local::.
38+
needs: website
39+
40+
- name: Build site
41+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
42+
shell: Rscript {0}
43+
44+
- name: Deploy to GitHub pages 🚀
45+
if: github.event_name != 'pull_request'
46+
uses: JamesIves/[email protected]
47+
with:
48+
clean: false
49+
branch: gh-pages
50+
folder: docs

DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Authors@R:
1111
Description: The reTCR R package offers a streamlined framework for processing and analyzing TCR repertoire data from high-throughput sequencing experiments. It leverages the MiXCR software with custom presets tailored to different library preparation methods, ensuring standardized data processing for comparative studies. The package integrates seamlessly with R, enabling researchers to query and filter TCR repertoire data based on various metadata characteristics such as disease phenotype, age, gender, and library preparation methods. Additionally, it incorporates the pyTCR tool, which calculates a comprehensive set of diversity metrics, including the Shannon-Wiener index, Gini coefficient, weighted usage of V, D, and J genes, and the mean length of CDR3 nucleotide sequences, providing a robust platform for in-depth immune repertoire analysis.
1212
License: MIT + file LICENSE
1313
Encoding: UTF-8
14-
URL: https://github.com/nahid18/reTCR, https://nahid18.github.io/reTCR
14+
URL: https://github.com/nahid18/reTCR, https://nahid18.github.io/reTCR, https://mangul-lab-usc.github.io/reTCR/
1515
BugReports: https://github.com/nahid18/reTCR/issues
1616
Roxygen: list(markdown = TRUE)
1717
RoxygenNote: 7.3.1

_pkgdown.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
url: ~
2-
1+
url: https://mangul-lab-usc.github.io/reTCR/
32
template:
43
bootstrap: 5
4+

0 commit comments

Comments
 (0)