nf-core/bacass
Simple bacterial assembly and annotation pipeline
2.2.0). The latest
stable release is
2.4.0
.
Define where the pipeline should find input data and save output data.
Path to tab-separated sample sheet
stringThe 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})$Parameters for QC and trim short-reads
save files that failed to pass trimming thresholds ending in *.fail.fastq.gz
booleansave all merged reads to the a file ending in *.merged.fastq.gz
booleanSkip FastQC
booleanSkip FastP
booleanPath to Kraken2 database.
stringParameters for the assembly
The assembler to use for assembly. Use the appropriate assembler according to the chosen assembly_type. Refer to the README.md for further clarification.
stringWhich type of assembly to perform.
stringExtra arguments for Unicycler
stringAllowed technologies for long read assembly.
stringThis can be used to supply extra options to the Canu assembler. Will be ignored when other assemblers are used.
stringWhich assembly polishing method to use.
stringParameters for the annotation
The annotation method to annotate the final assembly.
stringExtra arguments for prokka annotation tool.
stringPath to Bakta database
stringDownload Bakta database
booleanSpecifies a configuration file for the DFAST annotation method.
stringassets/test_config_dfast.pySkip running Kraken2 classifier on reads.
booleanSkip annotating the assembly with Prokka /DFAST.
booleanSkip running PycoQC on long read input.
booleanSkip polishing the long-read assembly with fast5 input. Will not affect short/hybrid assemblies.
booleanSkip MultiQC
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.
stringSet 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|d|day)\s*)+$Less common options for the pipeline, typically set in a config file.
Display help text.
booleanDisplay version and exit.
booleanMethod used to save pipeline results to output directory.
stringMultiQC report title. Printed as page header, used for filename if not otherwise specified.
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
booleantrueShow all params when using --help
booleanValidation of parameters fails when an unrecognised parameter is found.
booleanValidation of parameters in lenient more.
booleanA comma separated string of inputs the schema validation should ignore
stringmodules,igenomes_base