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.

required
type: string
pattern: ^\S+\.csv$

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

required
type: string

Email address for completion summary.

type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Database settings, to specify the FASTA, create decoys and entrapments

Input FASTA protein database

type: string
pattern: .(fasta|faa)$

This parameter specifies for an entrapment search the fold of entrapment proteins per target protein. No database will be created if 0.

type: integer

Add this parameter when you want to skip the generation of the decoy database.

type: boolean

Search parameters that are common to all search engines.

The precursor tolerance in PPM

type: integer
default: 10

The fragment tolerance in Dalton

type: number
default: 0.02

Search parameters specific to Sage

Path to the Sage params file. If not set or null, the provided default in assets is used.

type: string

Whether the database should be split during Sage search. This greatly reduces memory consumption when using large databases (beta feature)

type: boolean

Number of proteins per database chunk when prefiltering is active.

type: integer

Enable/disable search engines.

Enables spectrum identification with Comet.

type: boolean
default: true

Enables spectrum identification with Sage.

type: boolean
default: true

This is the default comet parameters file. In this file, parameters can be set, which are neither passed by common runtime (threads, fasta, …) or by common search engine parameters. If not set or null, the provided default in assets is used.

type: string

Enable/disable rescoring algorithms.

Enables rescoring with Percolator. Some rescorings (MS2Rescore, Oktoberfest) depend on Percolator results, so Percolator will be run if any of these are enabled, even if this parameter is set to false.

type: boolean
default: true

Enables rescoring with MS2Rescore.

type: boolean
default: true

The MS2PIP model to use for MS2Rescore. Models can be found here: https://ms2pip.readthedocs.io/en/latest/prediction-models/

type: string
default: HCD

Optional directory with pre-downloaded MS2PIP model files. If set to null, the respective model is downloaded and saved in the results directory.

type: string

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

Git commit id for Institutional configs.

hidden
type: string
default: master

Base directory for Institutional configs.

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

Institutional config name.

hidden
type: string

Institutional config description.

hidden
type: string

Institutional config contact information.

hidden
type: string

Institutional config URL link.

hidden
type: string

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

Display version and exit.

hidden
type: boolean

Method used to save pipeline results to output directory.

hidden
type: string

Email address for completion summary, only when pipeline fails.

hidden
type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Send plain-text email instead of HTML.

hidden
type: boolean

Do not use coloured log outputs.

hidden
type: boolean

Incoming hook URL for messaging service

hidden
type: string

Boolean whether to validate parameters against the schema at runtime

hidden
type: boolean
default: true

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

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

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

hidden
type: string

Display the help message.

type: boolean,string

Display the full detailed help message.

type: boolean

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

type: boolean