Parameters

Input/output options

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

--genomic_data

type: 'string'

Input YAML specifying the location of all genomic data for assembly. See the documentation for a full specification.

required

--assembly_specs

type: 'string'

YAML file specifying the parameters for a set of assemblies, including datasets and arguments. See the documentation for a full specification.

required

--outdir

type: 'string'

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

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

Input preparation options

Options to control input preparation prior to starting assembly.

--kmer_size

type: 'integer'

Kmer size to use for all kmer-based subroutines in the Kmer profiling subworkflow. This parameter is overridden by the provided kmer size for a given input read set if a FastK database is provided.

default: 31

--genomescope_args

type: 'string'

Optional command-line arguments to pass to genomescope2.

--save_fastk_databases

type: 'boolean'

Save the FastK databases generated by the pipeline to the output directory.

Purging options

Options to contol the purging of duplicated haplotigs from an assembly.

--purging_reads_chunk_size

type: 'integer'

How many reads to map in a single chunk when mapping reads to the primary assembly during purging.

default: 500000
required

--ont_minimap2_map_mode

type: 'string'

Which minimap2 mapping mode to use when mapping ONT? See https://lh3.github.io/minimap2/minimap2.html for a full list.

default: 'map-ont'
required

Polishing options

Options to control polishing an assembly.

--polishing_longranger_container_path

type: 'string'

Path to a container with longranger to use for the longranger processes. Required for polishing to run.

--polishing_n_chunks_bed

type: 'integer'

Number of chunks to split assembly into for polishing.

default: 100

Hi-C mapping and scaffolding options

Options to control the mapping of Hi-C reads and scaffolding of an assembly.

--hic_aligner

type: 'string'

Which aligner to use to align Hi-C reads to the reference

--hic_mapping_cram_chunk_size

type: 'integer'

Number of CRAM slices to include per CRAM file per mapping chunk. Lower values mean more Hi-C mapping jobs are spawned, but each should have a lower run time.

default: 10000

--hic_mapping_minq

type: 'integer'

Minimum MapQ score for a Hi-C read to be retained for scaffolding.

default: 10

--scaffolding_cool_bin_size

type: 'integer'

Bin size to use when building cooler contact maps.

default: 1000

Assembly QC options

Parameters to configure the assembly QC steps that run for each assembly generated.

--busco_lineage_directory

type: 'string'

Path to a local directory containing pre-downloade BUSCO lineages.

Lineage datasets can be downloaded using busco --download.

Organelle assembly options

--mitohifi_min_ref_len

type: 'integer'

The minimum size of a reference organellar genome to use in reference-based organelle assembly with Mitohifi

default: 15000
required

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

--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.

--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, --monochrome_logs, --hook_url, --validate_params, --pipelines_testdata_base_path, --trace_report_suffix

to show all hidden params.