nf-core/ampliseq
Amplicon sequencing analysis workflow using DADA2 and QIIME2
2.6.0). The latest
stable release is
2.15.0
.
Either a tab-separated 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, …).
stringThe output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
stringIf data has binned quality scores such as Illumina NovaSeq
booleanIf 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 analysing ITS amplicons or any other region with large length variability with Illumina paired end reads
booleanIf samples were sequenced in multiple sequencing runs
booleanNaming of sequencing files
string/*_R{1,2}_001.fastq.gzSet read count threshold for failed samples.
integer1Ignore input files with too few reads.
booleanCutadapt will retain untrimmed reads, choose only if input reads are not expected to contain primer sequences.
booleanSets the minimum overlap for valid matches of primer sequences with reads for cutadapt (-O).
integer3Sets the maximum error rate for valid matches of primer sequences with reads for cutadapt (-e).
number0.1Cutadapt will be run twice to ensure removal of potential double primers
booleanIgnore files with too few reads after trimming.
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
integer50DADA2 read filtering option
integerMode of sample inference: “independent”, “pooled” or “pseudo”
stringNot recommended: When paired end reads are not sufficiently overlapping for merging.
booleanName of supported database, and optionally also version number
stringPath to a custom DADA2 reference taxonomy database
stringPath to a custom DADA2 reference taxonomy database for species assignment
stringComma separated list of taxonomic levels used in DADA2’s assignTaxonomy function
stringIf the expected amplified sequences are extracted from the DADA2 reference taxonomy database
booleanNewick file with reference phylogenetic tree. Requires also --pplace_aln and --pplace_model.
stringFile with reference sequences. Requires also --pplace_tree and --pplace_model.
stringPhylogenetic model to use in placement, e.g. ‘LG+F’ or ‘GTR+I+F’. Requires also --pplace_tree and --pplace_aln.
stringMethod used for alignment, “hmmer” or “mafft”
stringTab-separated file with taxonomy assignments of reference sequences.
stringA name for the run
stringName of supported database, and optionally also version number
stringPath to QIIME2 trained classifier file (typically *-classifier.qza)
stringName of supported database, and optionally also version number
stringIf ASVs should be assigned to UNITE species hypotheses (SHs). Only relevant for ITS data.
booleanPart of ITS region to use for taxonomy assignment: “full”, “its1”, or “its2”
stringCutoff for partial ITS sequences. Only full sequences by default.
integerEnable SSU filtering. Comma separated list of kingdoms (domains) in Barrnap, a combination (or one) of “bac”, “arc”, “mito”, and “euk”. ASVs that have their lowest evalue in that kingdoms are kept.
stringMinimal ASV length
integerMaximum ASV length
integerFilter ASVs based on codon usage
booleanStarting position of codon tripletts
integer1Ending position of codon tripletts
integerDefine stop codons
stringTAA,TAGComma separated list of unwanted taxa, to skip taxa filtering use “none”
stringmitochondria,chloroplastAbundance filtering
integer1Prevalence filtering
integer1Comma separated list of metadata column headers for statistics.
stringComma separated list of metadata column headers for plotting average relative abundance barplots.
stringFormula for QIIME2 ADONIS metadata feature importance test for beta diversity distances
stringIf the functional potential of the bacterial community is predicted.
booleanIf data should be exported in SBDI (Swedish biodiversity infrastructure) Excel format.
booleanMinimum rarefaction depth for diversity analysis. Any sample below that threshold will be removed.
integer500Minimum sample counts to retain a sample for ANCOM analysis. Any sample below that threshold will be removed.
integer1Minimum taxonomy agglomeration level for taxonomic classifications
integer2Maximum taxonomy agglomeration level for taxonomic classifications
integer6Skip FastQC
booleanSkip primer trimming with cutadapt. This is not recommended! Use only in case primer sequences were removed before and the data does not contain any primer sequences.
booleanSkip quality check with DADA2. Can only be skipped when --trunclenf and --trunclenr are set.
booleanSkip annotating SSU matches.
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 taxonomic classification with DADA2
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
booleanLess common options for the pipeline, typically set in a config file.
Specifies the random seed.
integer100Email address for completion summary.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$Show all params when using --help
booleanDisplay help text.
booleanDisplay version and exit.
booleanMethod used to save pipeline results to output directory.
stringEmail 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.
booleanIncoming hook URL for messaging service
stringCustom config file to supply to MultiQC.
stringCustom logo file to supply to MultiQC. File name must also be set in the MultiQC config file
stringCustom MultiQC yaml file containing HTML including a methods description.
stringDirectory to keep pipeline Nextflow logs and reports.
string${params.outdir}/pipeline_infoBoolean whether to validate parameters against the schema at runtime
booleantrueSet 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*)+$Parameters 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.
string