diff --git a/404.html b/404.html index d39069b6..2e2a657d 100644 --- a/404.html +++ b/404.html @@ -24,7 +24,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 diff --git a/LICENSE-text.html b/LICENSE-text.html index 95c3eab5..84ccd69d 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -10,7 +10,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 diff --git a/LICENSE.html b/LICENSE.html index a0b79b0f..6b3ebf45 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -10,7 +10,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 diff --git a/articles/development.html b/articles/development.html index 58cafc5a..7a85fe17 100644 --- a/articles/development.html +++ b/articles/development.html @@ -26,7 +26,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 @@ -73,7 +73,7 @@ Development - 2023-07-19 + 2023-11-18 Source: vignettes/development.Rmd development.Rmd diff --git a/articles/index.html b/articles/index.html index 95e6013b..a541bad4 100644 --- a/articles/index.html +++ b/articles/index.html @@ -10,7 +10,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 diff --git a/articles/report_structure.html b/articles/report_structure.html index 9c05f57d..3e299ff4 100644 --- a/articles/report_structure.html +++ b/articles/report_structure.html @@ -26,7 +26,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 @@ -73,7 +73,7 @@ RNAsum Sections - 2023-07-19 + 2023-11-18 Source: vignettes/report_structure.Rmd report_structure.Rmd diff --git a/articles/tcga_projects_summary.html b/articles/tcga_projects_summary.html index 4550e667..11dbb824 100644 --- a/articles/tcga_projects_summary.html +++ b/articles/tcga_projects_summary.html @@ -26,7 +26,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 @@ -73,7 +73,7 @@ TCGA Projects - 2023-07-19 + 2023-11-18 Source: vignettes/tcga_projects_summary.Rmd tcga_projects_summary.Rmd diff --git a/articles/workflow.html b/articles/workflow.html index 9251df4a..736a230a 100644 --- a/articles/workflow.html +++ b/articles/workflow.html @@ -26,7 +26,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 @@ -73,7 +73,7 @@ Workflow Details - 2023-07-19 + 2023-11-18 Source: vignettes/workflow.Rmd workflow.Rmd diff --git a/authors.html b/authors.html index 610a1061..5cff1a6e 100644 --- a/authors.html +++ b/authors.html @@ -10,7 +10,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 diff --git a/index.html b/index.html index c6ac3445..7f1e5064 100644 --- a/index.html +++ b/index.html @@ -32,7 +32,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 @@ -123,12 +123,12 @@ Installationumccr channel: -conda install r-rnasum==0.0.X -c umccr -c conda-forge -c bioconda +conda install r-rnasum==0.0.X -c umccr -c conda-forge -c bioconda Docker image is available from the GitHub Container Registy: -docker pull ghcr.io/umccr/rnasum:latest +docker pull ghcr.io/umccr/rnasum:latest Workflow @@ -276,112 +276,112 @@ WGS Usage -rnasum_cli=$(Rscript -e 'x = system.file("cli", package = "RNAsum"); cat(x, "\n")' | xargs) -export PATH="${rnasum_cli}:${PATH}" -$ rnasum.R --version -rnasum.R x.x.x - -$ rnasum.R --help -Usage -===== - -/Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library/RNAsum/cli/rnasum.R [options] - - -Options -======= ---arriba_pdf=ARRIBA_PDF - File path of Arriba PDF output - ---arriba_tsv=ARRIBA_TSV - File path of Arriba TSV output - ---batch_rm=BATCH_RM - Remove batch-associated effects between datasets? [def: TRUE] - ---cn_gain=CN_GAIN - CN threshold value to classify genes within gained regions [def: 95] - ---cn_loss=CN_LOSS - CN threshold value to classify genes within lost regions [def: 5] - ---dataset=DATASET - Dataset to be used as external reference cohort [def: PANCAN] - ---dataset_name_incl=DATASET_NAME_INCL - Include dataset in report name? [def: FALSE] - ---dragen_fusions=DRAGEN_FUSIONS - File path to DRAGEN RNA-seq 'fusion_candidates.final' output - ---drugs=DRUGS - Include drug matching section in report? [def: FALSE] - ---filter=FILTER - Filter out low expressed genes? [def: TRUE] - ---hide_code_btn=HIDE_CODE_BTN - Hide "Code" button above code chunks in report? [def: TRUE] - ---immunogram=IMMUNOGRAM - Include immunogram in report? [def: FALSE] - ---log=LOG - Log2 transform data before normalisation? [def: TRUE] - ---manta_tsv=MANTA_TSV - File path to umccrise 'manta.tsv' output - ---norm=NORM - Normalisation method - ---pcgr_splice_vars=PCGR_SPLICE_VARS - Include non-coding splice region variants reported in PCGR? [def: TRUE] - ---pcgr_tier=PCGR_TIER - Tier threshold for reporting variants reported in PCGR [def: 4] - ---pcgr_tiers_tsv=PCGR_TIERS_TSV - File path to PCGR 'snvs_indels.tiers.tsv' output - ---project=PROJECT - Project name - ---purple_gene_tsv=PURPLE_GENE_TSV - File path to PURPLE 'purple.cnv.gene.tsv' output - ---report_dir=REPORT_DIR - Directory path to output report - ---salmon=SALMON - File path to salmon 'quant.sf' output - ---sample_name=SAMPLE_NAME - Sample name to be presented in report - ---sample_source=SAMPLE_SOURCE - Type of investigated sample [def: -] - ---save_tables=SAVE_TABLES - Save interactive summary tables as HTML? [def: TRUE] - ---scaling=SCALING - Scaling for z-score transformation (gene-wise or group-wise) [def: gene-wise] - ---subject_id=SUBJECT_ID - Subject ID - ---top_genes=TOP_GENES - Number of top ranked genes to be presented in report - ---transform=TRANSFORM - Transformation method to be used when converting read counts [def: CPM] - ---umccrise=UMCCRISE - Directory path of the corresponding WGS-related data - ---help, -h - Show this help message and exit +rnasum_cli=$(Rscript -e 'x = system.file("cli", package = "RNAsum"); cat(x, "\n")' | xargs) +export PATH="${rnasum_cli}:${PATH}" +$ rnasum.R --version +rnasum.R x.x.x + +$ rnasum.R --help +Usage +===== + +/Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library/RNAsum/cli/rnasum.R [options] + + +Options +======= +--arriba_pdf=ARRIBA_PDF + File path of Arriba PDF output + +--arriba_tsv=ARRIBA_TSV + File path of Arriba TSV output + +--batch_rm=BATCH_RM + Remove batch-associated effects between datasets? [def: TRUE] + +--cn_gain=CN_GAIN + CN threshold value to classify genes within gained regions [def: 95] + +--cn_loss=CN_LOSS + CN threshold value to classify genes within lost regions [def: 5] + +--dataset=DATASET + Dataset to be used as external reference cohort [def: PANCAN] + +--dataset_name_incl=DATASET_NAME_INCL + Include dataset in report name? [def: FALSE] + +--dragen_fusions=DRAGEN_FUSIONS + File path to DRAGEN RNA-seq 'fusion_candidates.final' output + +--drugs=DRUGS + Include drug matching section in report? [def: FALSE] + +--filter=FILTER + Filter out low expressed genes? [def: TRUE] + +--hide_code_btn=HIDE_CODE_BTN + Hide "Code" button above code chunks in report? [def: TRUE] + +--immunogram=IMMUNOGRAM + Include immunogram in report? [def: FALSE] + +--log=LOG + Log2 transform data before normalisation? [def: TRUE] + +--manta_tsv=MANTA_TSV + File path to umccrise 'manta.tsv' output + +--norm=NORM + Normalisation method + +--pcgr_splice_vars=PCGR_SPLICE_VARS + Include non-coding splice region variants reported in PCGR? [def: TRUE] + +--pcgr_tier=PCGR_TIER + Tier threshold for reporting variants reported in PCGR [def: 4] + +--pcgr_tiers_tsv=PCGR_TIERS_TSV + File path to PCGR 'snvs_indels.tiers.tsv' output + +--project=PROJECT + Project name + +--purple_gene_tsv=PURPLE_GENE_TSV + File path to PURPLE 'purple.cnv.gene.tsv' output + +--report_dir=REPORT_DIR + Directory path to output report + +--salmon=SALMON + File path to salmon 'quant.sf' output + +--sample_name=SAMPLE_NAME + Sample name to be presented in report + +--sample_source=SAMPLE_SOURCE + Type of investigated sample [def: -] + +--save_tables=SAVE_TABLES + Save interactive summary tables as HTML? [def: TRUE] + +--scaling=SCALING + Scaling for z-score transformation (gene-wise or group-wise) [def: gene-wise] + +--subject_id=SUBJECT_ID + Subject ID + +--top_genes=TOP_GENES + Number of top ranked genes to be presented in report + +--transform=TRANSFORM + Transformation method to be used when converting read counts [def: CPM] + +--umccrise=UMCCRISE + Directory path of the corresponding WGS-related data + +--help, -h + Show this help message and exit Note Human reference genome GRCh38 (Ensembl based annotation version 86) is used for gene annotation by default. GRCh37 is no longer supported. @@ -402,40 +402,40 @@ Examples1. WTS and WGS data This is the most frequent and preferred case, in which the WGS-based findings will be used as a primary source for expression profile prioritisation. The genome-based results can be incorporated into the report by specifying the location of the corresponding umccrise output files (including results from PCGR, PURPLE, and Manta) using the --umccrise argument. The Mutated genes, Structural variants and CN altered genes report sections will contain information about expression levels of the mutated genes, genes located within detected SVs and CN altered regions, respectively. The results in the Fusion genes section will be ordered based on the evidence from genome-based data. A subset of the TCGA pancreatic adenocarcinoma dataset is used as reference cohort (--dataset TEST). -rnasum.R \ - --sample_name test_sample_WTS \ - --dataset TEST \ - --dragen_rnaseq inst/rawdata/test_data/dragen \ - --report_dir inst/rawdata/test_data/dragen/RNAsum \ - --umccrise inst/rawdata/test_data/umccrised/test_sample_WGS \ - --save_tables FALSE +rnasum.R \ + --sample_name test_sample_WTS \ + --dataset TEST \ + --dragen_rnaseq inst/rawdata/test_data/dragen \ + --report_dir inst/rawdata/test_data/dragen/RNAsum \ + --umccrise inst/rawdata/test_data/umccrised/test_sample_WGS \ + --save_tables FALSE The HTML report test_sample_WTS.RNAsum.html will be created in the inst/rawdata/test_data/dragen/RNAsum folder. 2. WTS data only In this scenario, only WTS data will be used and only expression levels of key UMCCR Cancer genes, Fusion genes, Immune markers and homologous recombination deficiency genes (HRD genes) will be reported. Moreover, gene fusions reported in the Fusion genes report section will not contain information about evidence from genome-based data. A subset of the TCGA pancreatic adenocarcinoma dataset is used as the reference cohort (--dataset TEST). -rnasum.R \ - --sample_name test_sample_WTS \ - --dataset TEST \ - --dragen_rnaseq inst/rawdata/test_data/dragen \ - --report_dir inst/rawdata/test_data/dragen/RNAsum \ - --save_tables FALSE +rnasum.R \ + --sample_name test_sample_WTS \ + --dataset TEST \ + --dragen_rnaseq inst/rawdata/test_data/dragen \ + --report_dir inst/rawdata/test_data/dragen/RNAsum \ + --save_tables FALSE The output HTML report test_sample_WTS.RNAsum.html will be created in the inst/rawdata/test_data/dragen/RNAsum folder. 3. WTS WGS and clinical data For samples derived from subjects, for which clinical information is available, a treatment regimen timeline can be added to the HTML report. This can be added by specifying the location of a relevant excel spreadsheet (see example test_clinical_data.xlsx under inst/rawdata/test_data/test_clinical_data.xlsx) using the --clinical_info argument. In this spreadsheet, at least one of the following columns is expected: NEOADJUVANT REGIMEN, ADJUVANT REGIMEN, FIRST LINE REGIMEN, SECOND LINE REGIMEN or THIRD LINE REGIMEN, along with START and STOP dates of corresponding treatments. A subset of the TCGA pancreatic adenocarcinoma dataset is used as the reference cohort (--dataset TEST). -rnasum.R \ - --sample_name test_sample_WTS \ - --dataset TEST \ - --dragen_rnaseq $(pwd)/../rawdata/test_data/dragen \ - --report_dir $(pwd)/../rawdata/test_data/dragen/RNAsum \ - --umccrise $(pwd)/../rawdata/test_data/umccrised/test_sample_WGS \ - --save_tables FALSE \ - --clinical_info $(pwd)/../rawdata/test_data/test_clinical_data.xlsx \ - --save_tables FALSE +rnasum.R \ + --sample_name test_sample_WTS \ + --dataset TEST \ + --dragen_rnaseq $(pwd)/../rawdata/test_data/dragen \ + --report_dir $(pwd)/../rawdata/test_data/dragen/RNAsum \ + --umccrise $(pwd)/../rawdata/test_data/umccrised/test_sample_WGS \ + --save_tables FALSE \ + --clinical_info $(pwd)/../rawdata/test_data/test_clinical_data.xlsx \ + --save_tables FALSE The HTML report test_sample_WTS.RNAsum.html will be created in the ../rawdata/test_data/stratus/test_sample_WTS_dragen_v3.9.3/RNAsum folder. diff --git a/pkgdown.yml b/pkgdown.yml index 22ec1c3a..a3ec72d1 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,4 +1,4 @@ -pandoc: 3.1.3 +pandoc: 2.19.2 pkgdown: 2.0.7 pkgdown_sha: ~ articles: @@ -6,7 +6,7 @@ articles: report_structure: report_structure.html tcga_projects_summary: tcga_projects_summary.html workflow: workflow.html -last_built: 2023-07-19T09:03Z +last_built: 2023-11-18T03:42Z urls: reference: https://umccr.github.io/rnasum/reference article: https://umccr.github.io/rnasum/articles diff --git a/reference/CapStr.html b/reference/CapStr.html index 0627b3a6..9e3f2e54 100644 --- a/reference/CapStr.html +++ b/reference/CapStr.html @@ -10,7 +10,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 diff --git a/reference/REFERENCE_DATASETS.html b/reference/REFERENCE_DATASETS.html index ec6debf6..d9b50ded 100644 --- a/reference/REFERENCE_DATASETS.html +++ b/reference/REFERENCE_DATASETS.html @@ -10,7 +10,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 diff --git a/reference/RNAsum-package.html b/reference/RNAsum-package.html index c1c7176d..1ab2b227 100644 --- a/reference/RNAsum-package.html +++ b/reference/RNAsum-package.html @@ -10,7 +10,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 diff --git a/reference/arriba_pdf_read.html b/reference/arriba_pdf_read.html index 08cd9e0b..6378de8e 100644 --- a/reference/arriba_pdf_read.html +++ b/reference/arriba_pdf_read.html @@ -12,7 +12,7 @@ RNAsum - 0.4.10 + 0.5.0.9000 @@ -94,10 +94,10 @@ Examples#> # A tibble: 4 × 2 #> nm png #> <chr> <chr> -#> 1 EP300.AS1__XRCC6_chr22.41195482_chr22.41636113 /tmp/RtmpF… -#> 2 LAPTM4A__AC098828.3_chr2.20051410_chr2.20064511 /tmp/RtmpF… -#> 3 FNIP1__AC112492.1.83716..DCAF8L1.218._chr5.131642783_chrX.27977775 /tmp/RtmpF… -#> 4 ZFP64__MORC2_chr20.52096811_chr22.30963497 /tmp/RtmpF… +#> 1 EP300.AS1__XRCC6_chr22.41195482_chr22.41636113 /tmp/RtmpT… +#> 2 LAPTM4A__AC098828.3_chr2.20051410_chr2.20064511 /tmp/RtmpT… +#> 3 FNIP1__AC112492.1.83716..DCAF8L1.218._chr5.131642783_chrX.27977775 /tmp/RtmpT… +#> 4 ZFP64__MORC2_chr20.52096811_chr22.30963497 /tmp/RtmpT…
vignettes/development.Rmd
development.Rmd
vignettes/report_structure.Rmd
report_structure.Rmd
vignettes/tcga_projects_summary.Rmd
tcga_projects_summary.Rmd
vignettes/workflow.Rmd
workflow.Rmd
conda install r-rnasum==0.0.X -c umccr -c conda-forge -c bioconda
docker pull ghcr.io/umccr/rnasum:latest
rnasum_cli=$(Rscript -e 'x = system.file("cli", package = "RNAsum"); cat(x, "\n")' | xargs) -export PATH="${rnasum_cli}:${PATH}"
$ rnasum.R --version -rnasum.R x.x.x - -$ rnasum.R --help -Usage -===== - -/Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library/RNAsum/cli/rnasum.R [options] - - -Options -======= ---arriba_pdf=ARRIBA_PDF - File path of Arriba PDF output - ---arriba_tsv=ARRIBA_TSV - File path of Arriba TSV output - ---batch_rm=BATCH_RM - Remove batch-associated effects between datasets? [def: TRUE] - ---cn_gain=CN_GAIN - CN threshold value to classify genes within gained regions [def: 95] - ---cn_loss=CN_LOSS - CN threshold value to classify genes within lost regions [def: 5] - ---dataset=DATASET - Dataset to be used as external reference cohort [def: PANCAN] - ---dataset_name_incl=DATASET_NAME_INCL - Include dataset in report name? [def: FALSE] - ---dragen_fusions=DRAGEN_FUSIONS - File path to DRAGEN RNA-seq 'fusion_candidates.final' output - ---drugs=DRUGS - Include drug matching section in report? [def: FALSE] - ---filter=FILTER - Filter out low expressed genes? [def: TRUE] - ---hide_code_btn=HIDE_CODE_BTN - Hide "Code" button above code chunks in report? [def: TRUE] - ---immunogram=IMMUNOGRAM - Include immunogram in report? [def: FALSE] - ---log=LOG - Log2 transform data before normalisation? [def: TRUE] - ---manta_tsv=MANTA_TSV - File path to umccrise 'manta.tsv' output - ---norm=NORM - Normalisation method - ---pcgr_splice_vars=PCGR_SPLICE_VARS - Include non-coding splice region variants reported in PCGR? [def: TRUE] - ---pcgr_tier=PCGR_TIER - Tier threshold for reporting variants reported in PCGR [def: 4] - ---pcgr_tiers_tsv=PCGR_TIERS_TSV - File path to PCGR 'snvs_indels.tiers.tsv' output - ---project=PROJECT - Project name - ---purple_gene_tsv=PURPLE_GENE_TSV - File path to PURPLE 'purple.cnv.gene.tsv' output - ---report_dir=REPORT_DIR - Directory path to output report - ---salmon=SALMON - File path to salmon 'quant.sf' output - ---sample_name=SAMPLE_NAME - Sample name to be presented in report - ---sample_source=SAMPLE_SOURCE - Type of investigated sample [def: -] - ---save_tables=SAVE_TABLES - Save interactive summary tables as HTML? [def: TRUE] - ---scaling=SCALING - Scaling for z-score transformation (gene-wise or group-wise) [def: gene-wise] - ---subject_id=SUBJECT_ID - Subject ID - ---top_genes=TOP_GENES - Number of top ranked genes to be presented in report - ---transform=TRANSFORM - Transformation method to be used when converting read counts [def: CPM] - ---umccrise=UMCCRISE - Directory path of the corresponding WGS-related data - ---help, -h - Show this help message and exit
rnasum_cli=$(Rscript -e 'x = system.file("cli", package = "RNAsum"); cat(x, "\n")' | xargs) +export PATH="${rnasum_cli}:${PATH}"
$ rnasum.R --version +rnasum.R x.x.x + +$ rnasum.R --help +Usage +===== + +/Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library/RNAsum/cli/rnasum.R [options] + + +Options +======= +--arriba_pdf=ARRIBA_PDF + File path of Arriba PDF output + +--arriba_tsv=ARRIBA_TSV + File path of Arriba TSV output + +--batch_rm=BATCH_RM + Remove batch-associated effects between datasets? [def: TRUE] + +--cn_gain=CN_GAIN + CN threshold value to classify genes within gained regions [def: 95] + +--cn_loss=CN_LOSS + CN threshold value to classify genes within lost regions [def: 5] + +--dataset=DATASET + Dataset to be used as external reference cohort [def: PANCAN] + +--dataset_name_incl=DATASET_NAME_INCL + Include dataset in report name? [def: FALSE] + +--dragen_fusions=DRAGEN_FUSIONS + File path to DRAGEN RNA-seq 'fusion_candidates.final' output + +--drugs=DRUGS + Include drug matching section in report? [def: FALSE] + +--filter=FILTER + Filter out low expressed genes? [def: TRUE] + +--hide_code_btn=HIDE_CODE_BTN + Hide "Code" button above code chunks in report? [def: TRUE] + +--immunogram=IMMUNOGRAM + Include immunogram in report? [def: FALSE] + +--log=LOG + Log2 transform data before normalisation? [def: TRUE] + +--manta_tsv=MANTA_TSV + File path to umccrise 'manta.tsv' output + +--norm=NORM + Normalisation method + +--pcgr_splice_vars=PCGR_SPLICE_VARS + Include non-coding splice region variants reported in PCGR? [def: TRUE] + +--pcgr_tier=PCGR_TIER + Tier threshold for reporting variants reported in PCGR [def: 4] + +--pcgr_tiers_tsv=PCGR_TIERS_TSV + File path to PCGR 'snvs_indels.tiers.tsv' output + +--project=PROJECT + Project name + +--purple_gene_tsv=PURPLE_GENE_TSV + File path to PURPLE 'purple.cnv.gene.tsv' output + +--report_dir=REPORT_DIR + Directory path to output report + +--salmon=SALMON + File path to salmon 'quant.sf' output + +--sample_name=SAMPLE_NAME + Sample name to be presented in report + +--sample_source=SAMPLE_SOURCE + Type of investigated sample [def: -] + +--save_tables=SAVE_TABLES + Save interactive summary tables as HTML? [def: TRUE] + +--scaling=SCALING + Scaling for z-score transformation (gene-wise or group-wise) [def: gene-wise] + +--subject_id=SUBJECT_ID + Subject ID + +--top_genes=TOP_GENES + Number of top ranked genes to be presented in report + +--transform=TRANSFORM + Transformation method to be used when converting read counts [def: CPM] + +--umccrise=UMCCRISE + Directory path of the corresponding WGS-related data + +--help, -h + Show this help message and exit
Note
Human reference genome GRCh38 (Ensembl based annotation version 86) is used for gene annotation by default. GRCh37 is no longer supported.
This is the most frequent and preferred case, in which the WGS-based findings will be used as a primary source for expression profile prioritisation. The genome-based results can be incorporated into the report by specifying the location of the corresponding umccrise output files (including results from PCGR, PURPLE, and Manta) using the --umccrise argument. The Mutated genes, Structural variants and CN altered genes report sections will contain information about expression levels of the mutated genes, genes located within detected SVs and CN altered regions, respectively. The results in the Fusion genes section will be ordered based on the evidence from genome-based data. A subset of the TCGA pancreatic adenocarcinoma dataset is used as reference cohort (--dataset TEST).
umccrise
PCGR
PURPLE
Manta
--umccrise
Mutated genes
Structural variants
CN altered genes
Fusion genes
--dataset TEST
rnasum.R \ - --sample_name test_sample_WTS \ - --dataset TEST \ - --dragen_rnaseq inst/rawdata/test_data/dragen \ - --report_dir inst/rawdata/test_data/dragen/RNAsum \ - --umccrise inst/rawdata/test_data/umccrised/test_sample_WGS \ - --save_tables FALSE
rnasum.R \ + --sample_name test_sample_WTS \ + --dataset TEST \ + --dragen_rnaseq inst/rawdata/test_data/dragen \ + --report_dir inst/rawdata/test_data/dragen/RNAsum \ + --umccrise inst/rawdata/test_data/umccrised/test_sample_WGS \ + --save_tables FALSE
The HTML report test_sample_WTS.RNAsum.html will be created in the inst/rawdata/test_data/dragen/RNAsum folder.
test_sample_WTS.RNAsum.html
inst/rawdata/test_data/dragen/RNAsum
In this scenario, only WTS data will be used and only expression levels of key UMCCR Cancer genes, Fusion genes, Immune markers and homologous recombination deficiency genes (HRD genes) will be reported. Moreover, gene fusions reported in the Fusion genes report section will not contain information about evidence from genome-based data. A subset of the TCGA pancreatic adenocarcinoma dataset is used as the reference cohort (--dataset TEST).
UMCCR Cancer genes
Immune markers
HRD genes
rnasum.R \ - --sample_name test_sample_WTS \ - --dataset TEST \ - --dragen_rnaseq inst/rawdata/test_data/dragen \ - --report_dir inst/rawdata/test_data/dragen/RNAsum \ - --save_tables FALSE
rnasum.R \ + --sample_name test_sample_WTS \ + --dataset TEST \ + --dragen_rnaseq inst/rawdata/test_data/dragen \ + --report_dir inst/rawdata/test_data/dragen/RNAsum \ + --save_tables FALSE
The output HTML report test_sample_WTS.RNAsum.html will be created in the inst/rawdata/test_data/dragen/RNAsum folder.
For samples derived from subjects, for which clinical information is available, a treatment regimen timeline can be added to the HTML report. This can be added by specifying the location of a relevant excel spreadsheet (see example test_clinical_data.xlsx under inst/rawdata/test_data/test_clinical_data.xlsx) using the --clinical_info argument. In this spreadsheet, at least one of the following columns is expected: NEOADJUVANT REGIMEN, ADJUVANT REGIMEN, FIRST LINE REGIMEN, SECOND LINE REGIMEN or THIRD LINE REGIMEN, along with START and STOP dates of corresponding treatments. A subset of the TCGA pancreatic adenocarcinoma dataset is used as the reference cohort (--dataset TEST).
test_clinical_data.xlsx
inst/rawdata/test_data/test_clinical_data.xlsx
--clinical_info
NEOADJUVANT REGIMEN
ADJUVANT REGIMEN
FIRST LINE REGIMEN
SECOND LINE REGIMEN
THIRD LINE REGIMEN
START
STOP
rnasum.R \ - --sample_name test_sample_WTS \ - --dataset TEST \ - --dragen_rnaseq $(pwd)/../rawdata/test_data/dragen \ - --report_dir $(pwd)/../rawdata/test_data/dragen/RNAsum \ - --umccrise $(pwd)/../rawdata/test_data/umccrised/test_sample_WGS \ - --save_tables FALSE \ - --clinical_info $(pwd)/../rawdata/test_data/test_clinical_data.xlsx \ - --save_tables FALSE
rnasum.R \ + --sample_name test_sample_WTS \ + --dataset TEST \ + --dragen_rnaseq $(pwd)/../rawdata/test_data/dragen \ + --report_dir $(pwd)/../rawdata/test_data/dragen/RNAsum \ + --umccrise $(pwd)/../rawdata/test_data/umccrised/test_sample_WGS \ + --save_tables FALSE \ + --clinical_info $(pwd)/../rawdata/test_data/test_clinical_data.xlsx \ + --save_tables FALSE
The HTML report test_sample_WTS.RNAsum.html will be created in the ../rawdata/test_data/stratus/test_sample_WTS_dragen_v3.9.3/RNAsum folder.
../rawdata/test_data/stratus/test_sample_WTS_dragen_v3.9.3/RNAsum