You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/output.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -737,7 +737,9 @@ The principal output files are the same between Salmon and Kallisto:
737
737
-`tx2gene.tsv`: Tab-delimited file containing gene to transcripts ids mappings.
738
738
-`all_samples_transcript.SummarizedExperiment.rds`: RDS object that can be loaded in R that contains a [SummarizedExperiment](https://bioconductor.org/packages/release/bioc/html/SummarizedExperiment.html) container with the abundance TPM (`tpm`), estimated isoform-level raw counts (`counts`) and transcript length (`length`) in the assays slot for transcripts.
739
739
740
-
> **TIP:** You can access specific assay matrices from the `SummarizedExperiment` RDS object with the following R code:
740
+
:::tip
741
+
You can access specific assay matrices from the `SummarizedExperiment` RDS object with the following R code:
Copy file name to clipboardExpand all lines: docs/usage.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,16 +136,16 @@ When running Salmon in mapping-based mode via `--pseudo_aligner salmon`, supplyi
136
136
137
137
Two additional parameters `--extra_star_align_args` and `--extra_salmon_quant_args` were added in v3.10 of the pipeline that allow you to append any custom parameters to the STAR align and Salmon quant commands, respectively. Note, the `--seqBias` and `--gcBias` are not provided to Salmon quant by default so you can provide these via `--extra_salmon_quant_args '--seqBias --gcBias'` if required. You can now also supply additional arguments to Kallisto via `--extra_kallisto_quant_args`.
138
138
139
-
> **NB:** You can use `--skip_alignment --skip_pseudo_alignment` if you only want to run the pre-processing QC steps in the pipeline like FastQ, trimming etc. This will skip alignment, pseudoalignment and any post-alignment processing steps.
139
+
:::note
140
+
You can use `--skip_alignment --skip_pseudo_alignment` if you only want to run the pre-processing QC steps in the pipeline like FastQ, trimming etc. This will skip alignment, pseudoalignment and any post-alignment processing steps.
141
+
:::
140
142
141
143
Note that `--skip_alignment` and `--skip_pseudo_alignment` prevent both the execution of alignment/pseudoalignment steps and the building of their corresponding indices. For example, using `--skip_alignment` with `--aligner star_salmon` will skip both STAR alignment and index building.
142
144
143
145
## Quantification options
144
146
145
147
The current options align with STAR and quantify using either Salmon (`--aligner star_salmon`) / RSEM (`--aligner star_rsem`). You also have the option to pseudoalign and quantify your data with Salmon or Kallisto by providing the `--pseudo_aligner salmon` or `--pseudo_aligner kallisto` parameter, respectively.
146
148
147
-
Note that `--skip_alignment` and `--skip_pseudo_alignment` affect both the execution of alignment/pseudoalignment steps and which indices are built during genome preparation. If you specify `--aligner star_salmon` but use `--skip_alignment`, the STAR index will not be built at all, as the skip parameter prevents both the index building and the alignment steps. This behavior helps save computational resources when you know you won't be using certain alignment methods.
148
-
149
149
Since v3.0 of the pipeline, featureCounts is no longer used to perform gene/transcript quantification, however it is still used to generate QC metrics based on [biotype](http://www.ensembl.org/info/genome/genebuild/biotypes.html) information available within GFF/GTF genome annotation files. This decision was made primarily because of the limitations of featureCounts to appropriately quantify gene expression data. Please see [Zhao et al., 2015](https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0141910#pone-0141910-t001) and [Soneson et al., 2015](https://f1000research.com/articles/4-1521/v1).
150
150
151
151
For similar reasons, quantification will not be performed if using `--aligner hisat2` due to the lack of an appropriate option to calculate accurate expression estimates from HISAT2 derived genomic alignments - this may change in future releases (see [#822](https://github.com/nf-core/rnaseq/issues/822)). HISAT2 has been made available for those who have a preference for the alignment, QC and other types of downstream analysis compatible with it's output.
@@ -349,7 +349,9 @@ nextflow run \
349
349
350
350
This is not usually recommended with Salmon unless you also supply a previously generated decoy-aware Salmon transcriptome index.
351
351
352
-
> **NB:** Loading iGenomes configuration remains the default for reasons of consistency with other workflows, but should be disabled when not using iGenomes, applying the recommended usage above.
352
+
:::note
353
+
Loading iGenomes configuration remains the default for reasons of consistency with other workflows, but should be disabled when not using iGenomes, applying the recommended usage above.
354
+
:::
353
355
354
356
This will launch the pipeline with the `docker` configuration profile. See below for more information about profiles.
355
357
@@ -366,8 +368,9 @@ If you wish to repeatedly use the same parameters for multiple runs, rather than
366
368
367
369
Pipeline settings can be provided in a `yaml` or `json` file via `-params-file <file>`.
368
370
369
-
> [!WARNING]
370
-
> Do not use `-c <file>` to specify parameters as this will result in errors. Custom config files specified with `-c` must only be used for [tuning process resource specifications](https://nf-co.re/docs/usage/configuration#tuning-workflow-resources), other infrastructural tweaks (such as output directories), or module arguments (args).
371
+
:::warning
372
+
Do not use `-c <file>` to specify parameters as this will result in errors. Custom config files specified with `-c` must only be used for [tuning process resource specifications](https://nf-co.re/docs/usage/configuration#tuning-workflow-resources), other infrastructural tweaks (such as output directories), or module arguments (args).
373
+
:::
371
374
372
375
The above pipeline run specified with a params file in yaml format:
0 commit comments