Parameters

Input/output options

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

--input

Path to comma-separated file containing information about the samples in the experiment.

required

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.

--outdir

Path to the output directory where the results will be saved.

default: './results'

--email

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

--metadata

metadata

default: 'None'
required

--barcodes

barcode file

default: 'None'

--multiqc_title

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

--samplesheet

The bcl2fastq samplesheet

default: 'https://raw.githubusercontent.com/jianhong/16S_pipeline/assets/samplesheet.csv'
required hidden

--single_end

Single end or Paired end.

Reference options

Reference related files and options required for the workflow.

--silva_nr99

silva train set

default: 'https://zenodo.org/record/4587955/files/silva_nr99_v138.1_train_set.fa.gz?download=1'
required

The latest release can be found at: https://www.arb-silva.de/download/arb-files/

--silva_tax

silva species assignment

default: 'https://zenodo.org/record/4587955/files/silva_species_assignment_v138.1.fa.gz?download=1'
required

The latest release can be found at: https://www.arb-silva.de/download/arb-files/

--genome

Name of iGenomes reference.

hidden

If using a reference genome configured in the pipeline using iGenomes, use this parameter to give the ID for the reference. This is then used to build the full paths for all required reference genome files e.g. --genome GRCh38.

See the nf-core website docs for more details.

--igenomes_base

Directory / URL base for iGenomes references.

default: 's3://ngi-igenomes/igenomes'
hidden

--igenomes_ignore

Do not load the iGenomes reference config.

hidden

Do not load igenomes.config when running the pipeline. You may choose this option if you observe clashes between custom parameters and those supplied in igenomes.config.

Pipeline control options

Control the steps of the pipeline

--bcl2fastq

bcl2fastq command path

default: 'bcl2fastq'

--skip_bcl2fastq

skip bcl2fastq or not

--skip_fastqc

skip fastqc or not

--skip_demultiplex

skip demultiplex or not

The process will start from filter and be followed by dada2 processing . The input fastqs must follow the pattern of "*R{1,2}{fastq,fq}.gz"

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

Git commit id for Institutional configs.

default: 'master'
hidden

--custom_config_base

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

Institutional config name.

hidden

--config_profile_description

Institutional config description.

hidden

--config_profile_contact

Institutional config contact information.

hidden

--config_profile_url

Institutional config URL link.

hidden

Max job request options

Set the top limit for requested resources for any single job.

hidden

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.

--max_cpus

Maximum number of CPUs that can be requested for any single job.

default: 16
hidden

Use to set an upper-limit for the CPU requirement for each process. Should be an integer e.g. --max_cpus 1

--max_memory

Maximum amount of memory that can be requested for any single job.

default: '128.GB'
hidden

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$

--max_time

Maximum amount of time that can be requested for any single job.

default: '240.h'
hidden

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|day)\s*)+$

Generic options

Less common options for the pipeline, typically set in a config file.

hidden

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.

--help

Display help text.

hidden

--email_on_fail

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

Send plain-text email instead of HTML.

hidden

--max_multiqc_email_size

File size limit when attaching MultiQC reports to summary emails.

default: '25.MB'
hidden

--monochrome_logs

Do not use coloured log outputs.

hidden

--multiqc_config

Custom config file to supply to MultiQC.

hidden

--tracedir

Directory to keep pipeline Nextflow logs and reports.

default: '${params.outdir}/pipeline_info'
hidden

--validate_params

Boolean whether to validate parameters against the schema at runtime

default: 1
hidden

--show_hidden_params

Show all params when using --help

hidden

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.

--enable_conda

Run this workflow with Conda. You can also use '-profile conda' instead of providing this parameter.

hidden

The following uncommon parameters have been hidden: --samplesheet, --genome, --igenomes_base, --igenomes_ignore, --custom_config_version, --custom_config_base, --config_profile_name, --config_profile_description, --config_profile_contact, --config_profile_url, --max_cpus, --max_memory, --max_time, --help, --email_on_fail, --plaintext_email, --max_multiqc_email_size, --monochrome_logs, --multiqc_config, --tracedir, --validate_params, --show_hidden_params, --enable_conda

to show all hidden params.