Parameters
Path to comma-separated file containing information about the samples in the experiment.
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.
pattern: ^\S+\.csv$The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
default: 'results'Email address for completion summary.
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.
pattern: ^([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.
Genome accession where available or an identifier for draft assemblies
Path to file containing the BUSCO lineages for the genome species
If this file is not included, the relevant BUSCO lineages are automatically calculated using the taxon parameter.
When blastp_outext is 'txt', this is the list of columns that Diamond BLAST should print.
default: 'qseqid staxids bitscore qseqid sseqid pident length mismatch gapopen qstart qend sstart send evalue bitscore'When blastx_outext is 'txt', this is the list of columns that Diamond BLAST should print.
default: 'qseqid staxids bitscore qseqid sseqid pident length mismatch gapopen qstart qend sstart send evalue bitscore'Parameters used to describe centralised config profiles. These should not be edited.
The centralised nf-core configuration profiles use a handful of pipeline parameters to describe themselves. This information is then printed to the Nextflow log when you run a pipeline. You should not need to change these values when you run a pipeline.
Git commit id for Institutional configs.
default: 'master'Base directory for Institutional configs.
default: '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.
Set the top limit for requested resources for any single job.
If you are running on a smaller system, a pipeline step requesting more resources than are available may cause the Nextflow to stop the run with an error. These options allow you to cap the maximum resources requested by any single job so that the pipeline will run on your system.
Note that you can not increase the resources requested by any job using these options. For that you will need your own configuration file. See the nf-core website for details.
Maximum number of CPUs that can be requested for any single job.
default: 16Use to set an upper-limit for the CPU requirement for each process. Should be an integer e.g. --max_cpus 1
Maximum amount of memory that can be requested for any single job.
default: '128.GB'Use to set an upper-limit for the memory requirement for each process. Should be a string in the format integer-unit e.g. --max_memory '8.GB'
pattern: ^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Maximum amount of time that can be requested for any single job.
default: '240.h'Use to set an upper-limit for the time requirement for each process. Should be a string in the format integer-unit e.g. --max_time '2.h'
pattern: ^(\d+\.?\s*(s|m|h|d|day)\s*)+$Less common options for the pipeline, typically set in a config file.
These options are common to all nf-core pipelines and allow you to customise some of the core preferences for how the pipeline runs.
Typically these options would be set in a Nextflow config file loaded for all pipeline runs, such as ~/.nextflow/config.
Method used to save pipeline results to output directory.
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.
An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$File size limit when attaching MultiQC reports to summary emails.
default: '25.MB'Incoming hook URL for messaging service
Incoming hook URL for messaging service. Currently, MS Teams and Slack are supported.
Custom logo file to supply to MultiQC. File name must also be set in the MultiQC config file
Custom MultiQC yaml file containing HTML including a methods description.
Boolean whether to validate parameters against the schema at runtime
default: 1Show all params when using --help
By default, parameters set as hidden in the schema are not shown on the command line when a user runs with --help. Specifying this option will tell the pipeline to show all parameters.
Validation of parameters fails when an unrecognised parameter is found.
By default, when an unrecognised parameter is found, it returns a warinig.
Validation of parameters in lenient more.
Allows string values that are parseable as numbers or booleans. For further information see JSONSchema docs.