subworkflows/quantify_pseudo_alignment

Perform quantification with Salmon or Kallisto to produce count tables and SummarizedExperiment objects

rnaseqquantificationkallistosalmon

https://github.com/nf-core/modules/[...]/subworkflows/nf-core/quantify_pseudo_alignment

Description

Perform quantification with Salmon or Kallisto to produce count tables and SummarizedExperiment objects

Input

Name (Type)

Description

Pattern

`meta` (map)

Groovy Map containing study-level sample sheet information. e.g. [
id:‘SRP1234’ ].

`samplesheet` (file)

Sample sheet, to be baked into the colData of summarizedexperiment
objects.

*.{csv,tsv}

`reads` (file)

Channel with input FastQ files of size 1 and 2 for single-end and
paired-end data, respectively. OR a transcriptome-level BAM file if
running Salmon in alignment mode.

`index` (path)

Path to Salmon or Kallisto index in the tool-appropriate form.

`gtf` (file)

Channel with features in GTF format. Passed to pseudoaligners and used
to generate transcript/ gene mappings.

`gtf_id_attribute` (string)

Attribute in GTF file corresponding to the gene identifier.

`gtf_extra_attribute` (string)

GTF alternative gene attribute (e.g. gene_name)

`pseudo_aligner` (string)

Pseudoaligner, kallisto or salmon.

`alignment_mode` (boolean)

If running Salmon, run in alignment mode (true or false).

`lib_type` (string)

String to override Salmon library type.

`kallisto_quant_fraglen` (integer)

Estimated fragment length. Required if running Kallisto with
single-ended reads.

`kallisto_quant_fraglen_sd` (integer)

Estimated standard error for fragment length required by Kallisto in
single-end mode.

Output

Name (Type)

Description

Pattern

`meta` (map)

Groovy Map containing study-level sample sheet information. e.g. [
id:‘SRP1234’ ].

`results` (file)

Channel containing sample-wise results directories from the
pseudoaligner.

`multiqc` (file)

Channel containing those pseudoaligner outputs readable by MultiQC for
passing to workflow-level reporting.

`tpm_gene` (file)

Gene-level matrix of abundance values in TPM.

*.gene_tpm.tsv

`counts_gene` (file)

Gene-level matrix of unadjusted estimated counts from tximport
(countsFromAbundance = 'no').

*.gene_counts.tsv

`lengths_gene` (file)

Gene-level matrix of length values for modelling in downstream
analysis.

gene_lengths.tsv

`counts_gene_length_scaled` (file)

Gene-level matrix of estimated counts, generated from abundance (TPM)
values by scaling to library size, additionally scaled using the
average transcript length, averaged over samples and to library size,
using tximport countsFromAbundance = 'lengthScaledTPM'.

*.gene_counts_length_scaled.tsv

`counts_gene_scaled` (file)

Gene-level matrix of estimated counts, generated from abundance (TPM)
values by scaling to library size with tximport countsFromAbundance = 'scaledTPM'.

*.gene_counts_length_scaled.tsv

`tpm_transcript` (file)

Transcript-level matrix of abundance values in TPM.

*.transcript_tpm.tsv

`counts_transcript` (file)

Transcript-level matrix of unadjusted estimated counts from tximport
(countsFromAbundance = 'no').

*.transcript_counts.tsv

`lengths_transcript` (file)

Transcript-level matrix of length values for modelling in downstream
analysis.

transcript_lengths.tsv

`merged_gene_rds` (file)

Serialised SummarizedExperiment object containing gene level TPM
abundance values and counts generated from tximport with
countsFromAbundance = 'no'.

*.rds

`merged_gene_rds_length_scaled` (file)

Serialised SummarizedExperiment object containing gene level TPM
abundance values and counts generated from tximport with
countsFromAbundance='lengthScaledTPM'.

*.rds

`merged_gene_rds_scaled` (file)

Serialised SummarizedExperiment object containing gene level TPM
abundance values and counts generated from tximport with
countsFromAbundance='scaledTPM'.

*.rds

`merged_transcript_rds` (file)

Serialised SummarizedExperiment object containing transcript level TPM
abundance values and counts generated from tximport with
countsFromAbundance = 'no'.

*.rds

`versions` (file)

File containing software versions
Structure: [ path(versions.yml) ]

versions.yml

subworkflows/quantify_pseudo_alignment

Description

Input

`meta` (map)

`samplesheet` (file)

`reads` (file)

`index` (path)

`gtf` (file)

`gtf_id_attribute` (string)

`gtf_extra_attribute` (string)

`pseudo_aligner` (string)

`alignment_mode` (boolean)

`lib_type` (string)

`kallisto_quant_fraglen` (integer)

`kallisto_quant_fraglen_sd` (integer)

Output

`meta` (map)

`results` (file)

`multiqc` (file)

`tpm_gene` (file)

`counts_gene` (file)

`lengths_gene` (file)

`counts_gene_length_scaled` (file)

`counts_gene_scaled` (file)

`tpm_transcript` (file)

`counts_transcript` (file)

`lengths_transcript` (file)

`merged_gene_rds` (file)

`merged_gene_rds_length_scaled` (file)

`merged_gene_rds_scaled` (file)

`merged_transcript_rds` (file)

`versions` (file)

included in

included modules and subworkflows

maintainers

get in touch

subworkflows/quantify_pseudo_alignment

Description

Input

meta (map)

samplesheet (file)

reads (file)

index (path)

gtf (file)

gtf_id_attribute (string)

gtf_extra_attribute (string)

pseudo_aligner (string)

alignment_mode (boolean)

lib_type (string)

kallisto_quant_fraglen (integer)

kallisto_quant_fraglen_sd (integer)

Output

meta (map)

results (file)

multiqc (file)

tpm_gene (file)

counts_gene (file)

lengths_gene (file)

counts_gene_length_scaled (file)

counts_gene_scaled (file)

tpm_transcript (file)

counts_transcript (file)

lengths_transcript (file)

merged_gene_rds (file)

merged_gene_rds_length_scaled (file)

merged_gene_rds_scaled (file)

merged_transcript_rds (file)

versions (file)

included in

included modules and subworkflows

maintainers

get in touch

`meta` (map)

`samplesheet` (file)

`reads` (file)

`index` (path)

`gtf` (file)

`gtf_id_attribute` (string)

`gtf_extra_attribute` (string)

`pseudo_aligner` (string)

`alignment_mode` (boolean)

`lib_type` (string)

`kallisto_quant_fraglen` (integer)

`kallisto_quant_fraglen_sd` (integer)

`meta` (map)

`results` (file)

`multiqc` (file)

`tpm_gene` (file)

`counts_gene` (file)

`lengths_gene` (file)

`counts_gene_length_scaled` (file)

`counts_gene_scaled` (file)

`tpm_transcript` (file)

`counts_transcript` (file)

`lengths_transcript` (file)

`merged_gene_rds` (file)

`merged_gene_rds_length_scaled` (file)

`merged_gene_rds_scaled` (file)

`merged_transcript_rds` (file)

`versions` (file)