nf-core/detaxizer
A pipeline to identify (and remove) certain sequences from raw genomic data. Default taxon to identify (and remove) is Homo sapiens. Removal is optional.
Define where the pipeline should find input data and save output data.
Path to comma-separated file containing information about the samples in the experiment.
string^\S+\.csv$The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
stringEmail address for completion summary.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$MultiQC report title. Printed as page header, used for filename if not otherwise specified.
stringParameters which enable/disable certain steps used in the workflow.
If preprocessing with fastp should be turned on.
booleanSignifies that bbduk is used in the classification process. Can be combined with the ‘classification_kraken2’ parameter to run both.
booleanSignifies that kraken2 is used in the classification process. Can be combined with the ‘classification_bbduk’ parameter to run both. For kraken2 alone no parameter is needed.
booleanIf a validation of the classified reads via blastn should be carried out.
booleanIf the filtered reads should be classified with kraken2.
booleanWhen a validation via blastn is wanted but the filtering should use the IDs from the classification process.
booleanIf the filtering step should be skipped.
booleanSelect the read-filtering tool: seqkit or bbmap. seqkit normalizes FASTQ headers by temporarily renaming them; bbmap uses filterbyname.sh for exact header matching — Note: BBTools I/O forces any base that is N to Q=0 (!).
stringIf the removed reads should also be written to the output folder.
booleanIf the pre-processed reads should be used by the filter.
booleanSave intermediates to the results folder.
booleanParameter to customize bbduk execution
Location of the fasta which contains the contaminant sequences.
stringLength of k-mers for classification carried out by bbduk
integer27Parameters used by kraken2 to classify all reads provided. Fine-tuning of the isolation step can be done via the cutoff_* parameters.
The database which is used in the classification step. Please be aware that this default database will require ~60GB download and ~80GB RAM.
stringhttps://genome-idx.s3.amazonaws.com/kraken/k2_standard_20240605.tar.gzSave unclassified reads and classified reads (those assigned to any taxon, not specifically assessed or filtered) to separate files.
booleanSave unclassified reads and classified reads (those assigned to any taxon, not specifically assessed or filtered) to separate files. For the filtered reads.
booleanSave unclassified reads and classified reads (those assigned to any taxon, not specifically assessed or filtered) to separate files. For the removed reads.
booleanConfidence in the classification of a read as a certain taxon.
numberConfidence in the classification of a read as a certain taxon. For the filtered reads.
numberConfidence in the classification of a read as a certain taxon. For the removed reads.
numberIf a read has less k-mers assigned to the taxon/taxa to be assessed/to be filtered the read is ignored by the pipeline.
integerRatio per read of assigned to tax2filter k-mers to k-mers assigned to any other taxon (except unclassified).
numberRatio per read of assigned to tax2filter k-mers to unclassified k-mers.
numberThe taxon or taxonomic group to be assessed or filtered by the pipeline.
stringHomo sapiensParameters to fine-tune the output of blastn.
Location of the fasta from which the blastn database will be constructed.
stringCoverage is the percentage of the query sequence which can be found in the alignments of the sequence match. It can be used to fine-tune the validation step.
number40The expected(e)-value contains information on how many hits of the same score can be found in a database of the size used in the query by chance. The parameter can be used to fine-tune the validation step.
number0.01Identity is the percentage of the exact matches in the query and the sequence found in the database. The parameter can be used to fine-tune the validation step.
number40Options to control the behavior of fastp
fastp option defining the minimum readlength of a read
integerfastp option defining if the reads which failed to be trimmed should be saved
booleanfastp option to define the threshold of quality of an individual base
integerfastp option to define the mean quality for trimming
integer1fastp option if duplicates should be filtered or not before classification
booleanfastp option to define if the clipped reads should be saved
booleanReference genome related files and options required for the workflow.
Name of iGenomes reference.
stringGRCh38Do not load the iGenomes reference config.
booleanbooleantrueThe base path to the igenomes reference files
strings3://ngi-igenomes/igenomes/Options for generating input samplesheets for complementary downstream pipelines.
Turn on generation of samplesheets for downstream pipelines.
booleanSpecify a comma separated string in quotes to specify which pipeline to generate a samplesheet for.
stringtaxprofiler,mag^(taxprofiler|mag)(?:,(taxprofiler|mag)){0,1}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.
stringLess common options for the pipeline, typically set in a config file.
Display 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.
stringBoolean whether to validate parameters against the schema at runtime
booleantrueBase URL or local path to location of pipeline test dataset files
stringhttps://raw.githubusercontent.com/nf-core/test-datasets/Suffix to add to the trace report filename. Default is the date and time in the format yyyy-MM-dd_HH-mm-ss.
string