Parameters

Input/output options

Define where the pipeline should find input data and save output data.

--fasta

type: 'string'

Path/URL to one assembly FASTA file to analyse.

Supports .fa/.fasta and .fa.gz/.fasta.gz. Use this for single-assembly runs instead of --input.

--input

type: 'string'

Path to a CSV samplesheet describing one or more assemblies.

Expected header is fasta,taxid,mode,lineage,outdir. Row-level values override global --taxid/--mode/--lineage for that assembly.

pattern: ^\S+\.csv$

--taxid

type: 'number'

Global NCBI taxid for lineage discovery.

Used when samplesheet taxid is not provided. Required for modes ancestral/latest.

--lineage

type: 'string'

Global explicit BUSCO lineage(s) to add.

Comma-separated lineage names (e.g. mammalia,insecta). Used when samplesheet lineage is empty.

--mapping_directory

type: 'string'

Directory containing BUSCO taxid mapping files.

Files must be named _mapping.txt, for example odb12_mapping.txt.

--busco_db

type: 'string'

Local BUSCO database directory (optional).

If set, selected lineages are validated locally and BUSCO runs in offline mode.

--mode

type: 'string'

Global lineage discovery mode(s): basal, latest, ancestral.

Comma-separated values allowed. latest and ancestral require taxid and cannot be combined together.

--odb_versions

type: 'string'

ODB version(s) to use.

Comma-separated values (odb10,odb12,odb12.2). Each listed version requires a corresponding mapping file in mapping_directory.

--outdir

type: 'string'

The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.

required

--email

type: 'string'

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_title

type: 'string'

MultiQC report title. Printed as page header, used for filename if not otherwise specified.

Execution

Control the execution of the pipeline.

--use_work_dir_as_temp

type: 'boolean'

Use Nextflow work directory for temporary files where supported.

Institutional config options

Parameters used to describe centralised config profiles. These should not be edited.

hidden

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.

--custom_config_version

type: 'string'

Git commit id for Institutional configs.

default: 'master'
hidden

--custom_config_base

type: 'string'

Base directory for Institutional configs.

default: 'https://raw.githubusercontent.com/nf-core/configs/master'
hidden

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.

--config_profile_name

type: 'string'

Institutional config name.

hidden

--config_profile_description

type: 'string'

Institutional config description.

hidden

--config_profile_contact

type: 'string'

Institutional config contact information.

hidden

--config_profile_url

type: 'string'

Institutional config URL link.

hidden

Generic options

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.

--version

type: 'boolean'

Display version and exit.

hidden

--publish_dir_mode

type: 'string'

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_on_fail

type: 'string'

Email address for completion summary, only when pipeline fails.

hidden

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})$

--plaintext_email

type: 'boolean'

Send plain-text email instead of HTML.

hidden

--max_multiqc_email_size

type: 'string'

File size limit when attaching MultiQC reports to summary emails.

default: '25.MB'
hidden

--monochrome_logs

type: 'boolean'

Do not use coloured log outputs.

hidden

--hook_url

type: 'string'

Incoming hook URL for messaging service

hidden

Incoming hook URL for messaging service. Currently, MS Teams and Slack are supported.

--multiqc_config

type: 'string'

Custom config file to supply to MultiQC.

hidden
type: 'string'

Custom logo file to supply to MultiQC. File name must also be set in the MultiQC config file

hidden

--multiqc_methods_description

type: 'string'

Custom MultiQC yaml file containing HTML including a methods description.

--validate_params

type: 'boolean'

Boolean whether to validate parameters against the schema at runtime

default: 1
hidden

--pipelines_testdata_base_path

type: 'string'

Base URL or local path to location of pipeline test dataset files

default: 'https://raw.githubusercontent.com/nf-core/test-datasets/'
hidden

--trace_report_suffix

type: 'string'

Suffix to add to the trace report filename. Default is the date and time in the format yyyy-MM-dd_HH-mm-ss.

hidden

--help

Display the help message.

--help_full

type: 'boolean'

Display the full detailed help message.

--show_hidden

type: 'boolean'

Display hidden parameters in the help message (only works when --help or --help_full are provided).

The following uncommon parameters have been hidden: --custom_config_version, --custom_config_base, --config_profile_name, --config_profile_description, --config_profile_contact, --config_profile_url, --version, --publish_dir_mode, --email_on_fail, --plaintext_email, --max_multiqc_email_size, --monochrome_logs, --hook_url, --multiqc_config, --multiqc_logo, --validate_params, --pipelines_testdata_base_path, --trace_report_suffix

to show all hidden params.