nf-core/quantms
Quantitative mass spectrometry workflow. Currently supports proteomics experiments with complex experimental designs for DDA-LFQ, DDA-Isobaric and DIA-LFQ quantification.
Define where the pipeline should find input data and save output data.
URI/path to an SDRF file (.sdrf.tsv) OR OpenMS-style experimental design with paths to spectra files (.tsv)
string^\S+\.(?:tsv|sdrf)$The output directory where the results will be saved.
string./resultsEmail address for completion summary.
string^([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.
stringRoot folder in which the spectrum files specified in the SDRF/design are searched
stringOverwrite the file type/extension of the filename as specified in the SDRF/design
stringmzMLProteomics data acquisition method
stringOnly perform identification subworkflow.
booleanWhether export PSM from decoy in final identification results
booleanSettings that relate to the mandatory protein database and the optional generation of decoy entries. Note: Decoys for DIA will be created internally.
The fasta protein database used during database search. Note: For DIA data, it must not contain decoys.
string^\S+\.(?:fasta|fa)$Generate and append decoys to the given protein database
booleanPre- or suffix of decoy proteins in their accession
stringDECOY_Location of the decoy marker string in the fasta accession. Before (prefix) or after (suffix)
stringprefixChoose the method to produce decoys from input target database.
stringMaximum nr. of attempts to lower the amino acid sequence identity between target and decoy for the shuffle algorithm
integer30Target-decoy amino acid sequence identity threshold for the shuffle algorithm. if the sequence identity is above this threshold, shuffling is repeated. In case of repeated failure, individual amino acids are ‘mutated’ to produce a difference amino acid sequence.
number0.5Debug level for DecoyDatabase step. Increase for verbose logging.
integerIn case you start from profile mode mzMLs or the internal preprocessing during conversion with the ThermoRawFileParser fails (e.g. due to new instrument types), preprocessing has to be performed with OpenMS. Use this section to configure.
Activate OpenMS-internal peak picking
booleanPerform peakpicking in memory
booleanWhich MS levels to pick as comma separated list. Leave empty for auto-detection.
stringConvert bruker .d files to mzML
booleanForce initial re-indexing of input mzML files. Also fixes some common mistakes in slightly incomplete/outdated mzMLs. (Default: true for safety)
booleantrueA comma separated list of search engines to use (and combine). Valid: comet, msgf, sage
stringcometNumber of sage processes to be spawned.
integer1The enzyme to be used for in-silico digestion, in ‘OpenMS format’
stringTrypsinSpecify the amount of termini matching the enzyme cutting rules for a peptide to be considered. Valid values are fully (default), semi, or none
stringSpecify the maximum number of allowed missed enzyme cleavages in a peptide. The parameter is not applied if unspecific cleavage is specified as enzyme.
integer2Precursor mass tolerance used for database search. For High-Resolution instruments a precursor mass tolerance value of 5 ppm is recommended (i.e. 5). See also --precursor_mass_tolerance_unit.
integer5Precursor mass tolerance unit used for database search. Possible values are ‘ppm’ (default) and ‘Da’.
stringFragment mass tolerance used for database search. The default of 0.03 Da is for high-resolution instruments.
number0.03Fragment mass tolerance unit used for database search. Possible values are ‘ppm’ (default) and ‘Da’.
stringA comma-separated list of fixed modifications with their Unimod name to be searched during database search
stringCarbamidomethyl (C)A comma-separated list of variable modifications with their Unimod name to be searched during database search
stringOxidation (M)The fragmentation method used during tandem MS. (MS/MS or MS2).
stringHCDComma-separated range of integers with allowed isotope peak errors for precursor tolerance (like MS-GF+ parameter ‘-ti’). E.g. -1,3
string0,1Type of instrument that generated the data. ‘low_res’ or ‘high_res’ (default; refers to LCQ and LTQ instruments)
stringMSGF only: Labeling or enrichment protocol used, if any. Default: automatic
stringautomaticMinimum precursor ion charge. Omit the ’+’
integer2Maximum precursor ion charge. Omit the ’+’
integer4Minimum peptide length to consider (works with MSGF and in newer Comet versions)
integer6Maximum peptide length to consider (works with MSGF and in newer Comet versions)
integer40Specify the maximum number of top peptide candidates per spectrum to be reported by the search engine. Default: 1
integer1Maximum number of modifications per peptide. If this value is large, the search may take very long.
integer3Minimum number of peaks in the spectrum to be considered for the search engine. Default: 10
integer10The minimum precursor m/z for the in silico library generation or library-free search
numberThe maximum precursor m/z for the in silico library generation or library-free search
numberThe minimum fragment m/z for the in silico library generation or library-free search
numberThe maximum fragment m/z for the in silico library generation or library-free search
numberDebug level when running the database search. Logs become more verbose and at ‘>5’ temporary files are kept.
integerSettings for calculating a localization probability with LucXor for modifications with multiple candidate amino acids in a peptide.
Turn the mechanism on.
booleanWhich variable modifications to use for scoring their localization.
stringPhospho (S),Phospho (T),Phospho (Y)List of neutral losses to consider for mod. localization.
stringHow much to add to an amino acid to make it a decoy for mod. localization.
numberList of neutral losses to consider for mod. localization from an internally generated decoy sequence.
stringDebug level for Luciphor step. Increase for verbose logging and keeping temp files.
integerWhat to do when peptides are found that do not follow a unified set of rules (since search engines sometimes differ in their interpretation of them).
stringShould isoleucine and leucine be treated interchangeably when mapping search engine hits to the database? Default: true
booleantrueChoose between different rescoring/posterior probability calculation methods and set them up.
Skip PSM rescoring steps for specific cases, such as studying pure search engine results and search engine ranks
booleanHow to calculate posterior probabilities for PSMs:
- ‘percolator’ = Re-score based on PSM-feature-based SVM and transform distance to hyperplane for posteriors
- ‘fit_distributions’ = Fit positive and negative distributions to scores (similar to PeptideProphet)
stringFDR cutoff on PSM level (or peptide level; see Percolator options) per run before going into feature finding, map alignment and inference. This can be seen as a pre-filter. See
number0.1Debug level when running the IDFilter step. Increase for verbose logging
integerDebug level when running the re-scoring. Logs become more verbose and at ‘>5’ temporary files are kept.
integerDebug level when running the re-scoring. Logs become more verbose and at ‘>5’ temporary files are kept.
integerIn the following you can find help for the Percolator specific options that are only used if --posterior_probabilities was set to ‘percolator’.
Note that there are currently some restrictions to the original options of Percolator:
- no Percolator protein FDR possible (currently OpenMS’ FDR is used on protein level)
- no support for separate target and decoy databases (i.e. no min-max q-value calculation or target-decoy competition strategy)
- no support for combined or experiment-wide peptide re-scoring. Currently search results per input file are submitted to Percolator independently.
Calculate FDR on PSM (‘psm-level-fdrs’) or peptide level (‘peptide-level-fdrs’)?
stringThe FDR cutoff to be used during training of the SVM.
number0.05The FDR cutoff to be used during testing of the SVM.
number0.05Only train an SVM on a subset of PSMs, and use the resulting score vector to evaluate the other PSMs. Recommended when analyzing huge numbers (>1 million) of PSMs. When set to 0, all PSMs are used for training as normal. This is a runtime vs. quality tradeoff. Default: 300,000
integer300000Retention time features are calculated as in Klammer et al. instead of with Elude. Default: false
booleanUse additional features whose values are learnt by correct entries. See help text. Default: 0 = none
integerDebug level for Percolator step. Increase for verbose logging
integerUse this instead of Percolator if there are problems with Percolator (e.g. due to bad separation) or for performance
How to handle outliers during fitting:
- ignore_iqr_outliers (default): ignore outliers outside of
3*IQRfrom Q1/Q3 for fitting - set_iqr_to_closest_valid: set IQR-based outliers to the last valid value for fitting
- ignore_extreme_percentiles: ignore everything outside 99th and 1st percentile (also removes equal values like potential censored max values in XTandem)
- none: do nothing
stringDebug level for IDPEP step. Increase for verbose logging
integerHow to combine the probabilities from the single search engines: best, combine using a sequence similarity-matrix (PEPMatrix), combine using shared ion count of peptides (PEPIons). See help for further info.
stringOnly use the top N hits per search engine and spectrum for combination. Default: 0 = all
integerA threshold for the ratio of occurrence/similarity scores of a peptide in other runs, to be reported. See help.
numberDebug level for ConsensusID. Increase for verbose logging
integerExtracts and normalizes labeling information
Operate only on MSn scans where any of its precursors features a certain activation method. Set to empty to disable.
stringAllowed shift (left to right) in Th from the expected position
number0.002Minimum intensity of the precursor to be extracted
number1Minimum fraction of the total intensity. 0.0:1.0
numberMinimum intensity of the individual reporter ions to be extracted.
numberMaximum allowed deviation (in ppm) between theoretical and observed isotopic peaks of the precursor peak
number10Enable isotope correction (highly recommended)
booleantrueEnable normalization of the channel intensities
booleanThe reference channel, e.g. for calculating ratios.
string126Set the debug level
integerAssigns protein/peptide identifications to features or consensus features. Here, features generated from isobaric reporter intensities of fragment spectra.
Debug level for IDMapper step. Increase for verbose logging
integerTo group proteins, calculate scores on the protein (group) level and to potentially modify associations from peptides to proteins.
The inference method to use. ‘aggregation’ (default) or ‘bayesian’.
string[Ignored in Bayesian] How to aggregate scores of peptides matching to the same protein
string[Ignored in Bayesian] Also use shared peptides during score aggregation to protein level
booleantrue[Ignored in Bayesian] Minimum number of peptides needed for a protein identification
integer1Consider only the top X PSMs per spectrum to find the best PSM per peptide. 0 considers all.
integer1[Bayesian-only; Experimental] Update PSM probabilities with their posteriors under consideration of the protein probabilities.
booleanThe experiment-wide protein (group)-level FDR cutoff. Default: 0.01
number0.01Use picked protein FDRs
booleantrueThe experiment-wide PSM-level FDR cutoff. Default: 0.01
number0.01Debug level for the protein inference step. Increase for verbose logging
integerGeneral protein quantification settings for both LFQ and isobaric labelling.
Specify the labelling method that was used. Will be ignored if SDRF was given but is mandatory otherwise
stringCalculate protein abundance from this number of proteotypic peptides (most abundant first; ‘0’ for all, Default 3)
integer3Averaging method used to compute protein abundances from peptide abundances.
stringDistinguish between fraction and charge states of a peptide. (default: ‘false’)
booleanAdd the log2 ratios of the abundance values to the output.
booleanfalseScale peptide abundances so that medians of all samples are equal.(Default false)
booleanfalseUse the same peptides for protein quantification across all samples.(Default false)
booleanfalseInclude results for proteins with fewer proteotypic peptide than indicated by top.
booleantrueQuantify proteins based on:
- ‘unique_peptides’ = use peptides mapping to single proteins or a group of indistinguishable proteins (according to the set of experimentally identified peptides)
- ‘strictly_unique_peptides’ (only LFQ) = use peptides mapping to a unique single protein only
- ‘shared_peptides’ = use shared peptides, too, but only greedily for its best group (by inference score and nr. of peptides)
stringExport the results in mzTab format.
booleantrueChoose between feature-based quantification based on integrated MS1 signals (‘feature_intensity’; default) or spectral counting of PSMs (‘spectral_counting’). WARNING: ‘spectral_counting’ is not compatible with our MSstats step yet. MSstats will therefore be disabled automatically with that choice.
stringRecalibrates masses based on precursor mass deviations to correct for instrument biases. (default: ‘false’)
booleanOnly looks for quantifiable features at locations with an identified spectrum. Set to false to include unidentified features so they can be linked and matched to identified ones (= match between runs). (default: ‘true’)
booleantrueThe minimum probability (e.g.: 0.25) an identified (=id targeted) feature must have to be kept for alignment and linking (0=no filter).
number0.1The minimum probability (e.g.: 0.75) an unidentified feature must have to be kept for alignment and linking (0=no filter).
number0.75The minimum intensity for a feature to be considered for quantification. (default: ‘10000’)
number1000The order in which maps are aligned. Star = all vs. the reference with most IDs (default). TreeGuided = an alignment tree is calculated first based on similarity measures of the IDs in the maps.
stringAlso quantify decoys? (Usually only needed for Triqler post-processing output with --add_triqler_output, where it is auto-enabled)
booleanDebug level when running the re-scoring. Logs become more verbose and at ‘>666’ potentially very large temporary files are kept.
integerSettings for DIA-NN - a universal software for data-independent acquisition (DIA) proteomics data processing.
Choosing the MS2 mass accuracy setting automatically
booleantrueChoosing scan_window setting automatically
booleantrueSet the scan window radius to a specific value
integer8Only peaks with correlation sum exceeding min_corr will be considered
number2Peaks with correlation sum below corr_diff from maximum will not be considered
number1A single score will be used until RT alignment to save memory
booleantrueControls the protein inference mode
numberInstructs DIA-NN to add the organism identifier to the gene names
booleanThe spectral library to use for DIA-NN
stringSkip the preliminary analysis step, thus use the passed spectral library as-is insted of generating a local concensus library.
booleanThe log file for the empirical assembly, Only used if --skip_preliminary_analysis is set to true and --diann_speclib is passed. If passed, will use that log file to carry out the DIA-NN search, instead of running a preliminary search.
stringDebug level
integerEnable cross-run normalization between runs by diann.
booleantrueEnable random selection of spectrum files to generate empirical library.
booleanThe number of randomly selected spectrum files.
integer200Skip MSstats/MSstatsTMT for statistical post-processing?
booleanExperimental: Instead of all pairwise contrasts (default), uses the given condition name/number (corresponding to your experimental design) as a reference and creates pairwise contrasts against it.
stringExperimental: Allows full control over contrasts by specifying a set of contrasts in a semicolon separated list of R-compatible contrasts with the condition names/numbers as variables (e.g. 1-2;1-3;2-3). Overwrites --ref_condition.
stringThe threshold value for differential expressed proteins in MSstats plots based on adjusted p-value
number0.05Also create an output in Triqler’s format for an alternative manual post-processing with that tool
booleanWhich features to use for quantification per protein: ‘top3’ or ‘highQuality’ which removes outliers only
stringwhich summary method to use: ‘TMP’ (Tukey’s median polish) or ‘linear’ (linear mixed model)
stringOmit proteins with only one quantified feature?
booleantrueKeep features with only one or two measurements across runs?
booleantrueUse unique peptide for each protein
booleantrueRemove the features that have 1 or 2 measurements within each run
booleantrueselect the feature with the largest summmation or maximal value
stringsummarization methods to protein-level can be perfomed
stringReference channel based normalization between MS runs on protein level data?
booleantrueRemove ‘Norm’ channels from protein level data
booleantrueReference channel based normalization between MS runs on protein level data
booleantrueExport MSstats profile QC plots including all proteins
booleanEnable generation of pmultiqc report? default: ‘false’
booleanSkip idXML files (do not generate search engine scores) in pmultiqc report? default: ‘true’
booleanParameters used to describe centralised config profiles. These should not be edited.
Git commit id for Institutional configs.
stringmasterBase directory for Institutional configs.
stringhttps://raw.githubusercontent.com/nf-core/configs/masterInstitutional config name.
stringInstitutional config description.
stringInstitutional config contact information.
stringInstitutional config URL link.
stringSet the top limit for requested resources for any single job.
Maximum number of CPUs that can be requested for any single job.
integer16Maximum amount of memory that can be requested for any single job.
string128 GB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Maximum amount of time that can be requested for any single job.
string10d^(\d+\.?\s*(s|m|h|d|day)\s*)+$Less common options for the pipeline, typically set in a config file.
Display help text.
booleanDisplay version and exit.
booleanMethod used to save pipeline results to output directory.
stringEmail address for completion summary, only when pipeline fails.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$Send plain-text email instead of HTML.
booleanFile size limit when attaching MultiQC reports to summary emails.
string25.MB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Do not use coloured log outputs.
booleanIncoming hook URL for messaging service
stringCustom config file to supply to MultiQC.
stringSkip protein/peptide table plots with pmultiqc for large dataset.
booleanCustom logo file to supply to MultiQC. File name must also be set in the MultiQC config file
stringCustom MultiQC yaml file containing HTML including a methods description.
stringBoolean whether to validate parameters against the schema at runtime
booleantrueShow all params when using --help
booleanValidation of parameters fails when an unrecognised parameter is found.
booleanValidation of parameters in lenient more.
boolean