nf-core/ampliseq
Amplicon sequencing analysis workflow using DADA2 and QIIME2
2.2.0). The latest
stable release is
2.15.0
.
Either a tab-seperated sample sheet, a fasta file, or a folder containing zipped FastQ files
stringForward primer sequence
stringReverse primer sequence
stringPath to metadata sheet, when missing most downstream analysis are skipped (barplots, PCoA plots, …).
stringDefine where the pipeline should find input data and save output data.
If data is single-ended PacBio reads instead of Illumina
booleanIf data is single-ended IonTorrent reads instead of Illumina
booleanIf data is single-ended Illumina reads instead of paired-end
booleanIf data is long read ITS sequences, that need to be cut to ITS region only for taxonomy assignment
booleanIf samples were sequenced in multiple sequencing runs
booleanIf analysing ITS amplicons or any other region with large length variability with Illumina paired end reads
booleanNot recommended: When paired end reads are not sufficiently overlapping for merging.
booleanMode of sample inference: “independent”, “pooled” or “pseudo”
stringComma separated list of metadata column headers for statistics.
stringFormula for QIIME2 ADONIS metadata feature importance test for beta diversity distances
stringNaming of sequencing files
string/*_R{1,2}_001.fastq.gzIf the functional potential of the bacterial community is predicted.
booleanIf data should be exported in SBDI (Swedish biodiversity infrastructure) Excel format.
booleanPath to the output directory where the results will be saved.
string./resultsEmail address for completion summary.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$Cutadapt will retain untrimmed reads, choose only if input reads are not expected to contain primer sequences.
booleanCutadapt will be run twice to ensure removal of potential double primers
booleanDADA2 read truncation value for forward strand, set this to 0 for no truncation
integerDADA2 read truncation value for reverse strand, set this to 0 for no truncation
integerIf —trunclenf and —trunclenr are not set, these values will be automatically determined using this median quality score
integer25Assures that values chosen with —trunc_qmin will retain a fraction of reads.
number0.75DADA2 read filtering option
integer2DADA2 read filtering option
integerDADA2 read filtering option
integer50Minimum taxonomy agglomeration level for DADA2 classification
integer2Maximum taxonomy agglomeration level for DADA2 classification
integer7Minimum taxonomy agglomeration level for QIIME2 classification
integer2Maximum taxonomy agglomeration level for QIIME2 classification
integer6Name of supported database, and optionally also version number
stringIf the expected amplified sequences are extracted from the DADA2 reference taxonomy database
booleanName of supported database, and optionally also version number
stringPath to QIIME2 trained classifier file (typically *-classifier.qza)
stringIgnore input files considered too small (<1KB) for individual samples and continue the pipeline without those samples.
booleanIgnore files considered too small (<1KB) after trimming and continue the pipeline without those samples.
booleanComma separated list of unwanted taxa, to skip taxa filtering use “none”
stringmitochondria,chloroplastAbundance filtering
integer1Prevalence filtering
integer1Skip FastQC
booleanSkip all steps that are executed by QIIME2, including QIIME2 software download, taxonomy assignment by QIIME2, barplots, relative abundance tables, diversity analysis, differential abundance testing.
booleanSkip taxonomic classification. Incompatible with --sbdiexport
booleanSkip species level when using DADA2 for taxonomic classification. This reduces the required memory dramatically under certain conditions. Incompatible with --sbdiexport
booleanSkip producing barplot
booleanSkip producing any relative abundance tables
booleanSkip alpha rarefaction
booleanSkip alpha and beta diversity analysis
booleanSkip differential abundance testing
booleanSkip MultiQC reporting
booleanParameters used to describe centralised config profiles. These should not be edited.
Git commit id for Institutional configs.
stringmasterBase directory for Institutional configs.
stringhttps://raw.githubusercontent.com/nf-core/configs/masterInstitutional config name.
stringInstitutional config description.
stringInstitutional config contact information.
stringInstitutional config URL link.
stringMultiQC report title. Printed as page header, used for filename if not otherwise specified.
stringLess common options for the pipeline, typically set in a config file.
Display help text.
booleanEmail address for completion summary, only when pipeline fails.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$Send plain-text email instead of HTML.
booleanFile size limit when attaching MultiQC reports to summary emails.
string25.MB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Do not use coloured log outputs.
booleanCustom config file to supply to MultiQC.
stringDirectory to keep pipeline Nextflow logs and reports.
string${params.outdir}/pipeline_infoBoolean whether to validate parameters against the schema at runtime
booleantrueShow all params when using --help
booleanRun this workflow with Conda. You can also use ‘-profile conda’ instead of providing this parameter.
booleanSet the top limit for requested resources for any single job.
Maximum number of CPUs that can be requested for any single job.
integer16Maximum amount of memory that can be requested for any single job.
string128.GB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Maximum amount of time that can be requested for any single job.
string240.h^(\d+\.?\s*(s|m|h|day)\s*)+$