nf-core/genomeassembler
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$
You will need to create a design file with information about the samples in your experiment before running the pipeline. Use this parameter to specify its location. It has to be a comma-separated file with 3 columns, and a header row. See usage docs.
The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
string
./results
Email address for completion summary.
string
^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
Set this parameter to your e-mail address to get a summary e-mail with details of the run sent to you when the workflow exits. If set in your user config file (~/.nextflow/config
) then you don't need to specify this on the command line for every run.
MultiQC report title. Printed as page header, used for filename if not otherwise specified.
string
Parameters used to describe centralised config profiles. These should not be edited.
Git commit id for Institutional configs.
string
master
Base directory for Institutional configs.
string
https://raw.githubusercontent.com/nf-core/configs/master
If you're running offline, Nextflow will not be able to fetch the institutional config files from the internet. If you don't need them, then this is not a problem. If you do need them, you should download the files from the repo and tell Nextflow where to find them with this parameter.
Institutional config name.
string
Institutional config description.
string
Institutional config contact information.
string
Institutional config URL link.
string
Less common options for the pipeline, typically set in a config file.
Display version and exit.
boolean
Method used to save pipeline results to output directory.
string
The Nextflow publishDir
option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See Nextflow docs for details.
Email address for completion summary, only when pipeline fails.
string
^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.
Send plain-text email instead of HTML.
boolean
File size limit when attaching MultiQC reports to summary emails.
string
25.MB
^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$
Do not use coloured log outputs.
boolean
Incoming hook URL for messaging service
string
Incoming hook URL for messaging service. Currently, MS Teams and Slack are supported.
Custom config file to supply to MultiQC.
string
Custom logo file to supply to MultiQC. File name must also be set in the MultiQC config file
string
Custom MultiQC yaml file containing HTML including a methods description.
string
Boolean whether to validate parameters against the schema at runtime
boolean
true
Base URL or local path to location of pipeline test dataset files
string
https://raw.githubusercontent.com/nf-core/test-datasets/
Options controlling pipeline behavior
use reference genome
boolean
true
skip assembly steps
boolean
Skip assembly and perform only qc.
skip alignments during qc
boolean
Options for ONT reads
ONT reads available?
boolean
collect ONT reads into a single file
boolean
run porechop on ONT reads
boolean
read length for genomescope (ONT only)
integer
run jellyfish on ONT reads to compute k-mer distribution and estimate genome size
boolean
true
dump jellyfish output
boolean
kmer length to be used for jellyfish
integer
21
Options for HiFi reads
HiFi reads available?
boolean
run lima on HiFi reads?
boolean
file containing pacbio primers for trimming with lima
string
Options controlling assembly
Assembler to use. Valid choices are: 'hifiasm'
, 'flye'
, or 'flye_on_hifiasm'
. flye_on_hifiasm
will scaffold flye assembly (ont) on hifiasm (hifi) assembly using ragtag
string
expected genome size, optional
integer
flye mode
string
additional args for flye
string
Use hifi and ONT reads with hifiasm --ul
boolean
Extra arguments passed to hifiasm
string
Options for short reads
Short reads available?
boolean
trim short reads with trimgalore
boolean
true
kmer length for meryl / merqury
integer
21
Polishing options
Polish assembly with pilon? Requires short reads
boolean
Polish assembly with medaka (ONT only)
boolean
model to use with medaka
string
Scaffolding options
Scaffold with longstitch?
boolean
Scaffolding with links?
boolean
Scaffold with ragtag (requires reference)?
boolean
Options for QC tools
Run merqury
boolean
true
Long reads that should be used for QC when both ONT and HiFi reads are provided. Options are 'ONT'
or 'HIFI'
string
Run BUSCO?
boolean
true
Path to busco db (optional)
string
Busco lineage to use
string
brassicales_odb10
Run quast
boolean
true
Options controlling annotation liftover
Lift-over annotations (requires reference)?
boolean
true