nf-core/proteomicslfq
Proteomics label-free quantification (LFQ) analysis pipeline
22.10.6.
Learn more.
Define where the pipeline should find input data and save output data.
URI/path to an SDRF file (with ending .sdrf or .sdrf.tsv) OR a tab-separated experimental design file (.tsv) in OpenMS’ own format. All input files need to be specified with full paths in the corresponding columns. Those can be any URIs or local paths with schemata supported by nextflow (e.g. http/ftp/s3)
stringThe 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})$Less common options for the pipeline, typically set in a config file.
Display help text.
booleanMethod used to save pipeline results to output directory.
stringBoolean whether to validate parameters against the schema at runtime
booleantrueEmail 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.MBDo not use coloured log outputs.
booleanDirectory to keep pipeline Nextflow logs and reports.
string${params.outdir}/pipeline_infoShow all params when using --help
booleanSet 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.
string240.h^(\d+\.?\s*(s|m|h|day)\s*)+$Parameters 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 configs hostname.
stringInstitutional config name.
stringInstitutional config description.
stringInstitutional config contact information.
stringInstitutional config URL link.
stringAllows to overwrite the origins and types of input files as specified in the input design/SDRF.
Root folder in which the spectrum files specified in the design/SDRF are searched
stringOverwrite the file type/extension of the filename as specified in the SDRF
stringSettings that relate to the mandatory protein database and the optional generation of decoy entries.
The fasta protein database used during database search.
stringGenerate 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 the 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 different amino acid sequence.
number0.5In 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.
stringA comma separated list of search engines. Valid: comet, msgf
stringcometThe 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 (e.g. 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)
stringhigh_resMSGF 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.
integer3Debug 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.
integerAction to be taken if peptide sequences cannot be matched to any protein: 1) raise an error; 2) warn (unmatched PepHits will miss target/decoy annotation with downstream problems); 3) remove the hit. (default: ‘error’ valid: ‘error’, ‘warn’, ‘remove’)
stringShould isoleucine and leucine be treated interchangeably when mapping search engine hits to the database? Default: true
stringChoose between different rescoring/posterior probability calculation methods and set them up.
How 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 potential peptide level; see Percolator options) before going into feature finding, map alignment and inference.
number0.1Debug 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. discriminability 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
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
stringHow 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 occurence/similarity scores of a peptide in other runs, to be reported. See help.
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’.
stringThe experiment-wide protein (group)-level FDR cutoff. Default: 0.05
number0.05Quantify 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’ = 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)
stringChoose 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’)
stringTries a targeted requantification in files where an ID is missing, based on aggregate properties (i.e. RT) of the features in other aligned files (e.g. ‘mean’ of RT). (WARNING: increased memory consumption and runtime. Only useful with multiple fraction groups/samples). ‘false’ turns this feature off. (default: ‘false’)
stringOnly 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’)
stringThe 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.
integerParameters for statistical post processing and quantification visualization. Currently only possible with quantification_method = feature_based.
Skip the MSstats Rscripts for automated statistical post-processing?
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?
booleanInstead 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.
stringAllows full control over contrasts by specifying a set of contrasts in a semicolon seperated list of R-compatible limma-style contrasts
with the condition names/numbers as variables (e.g. 1-2;1-3;2-3).
Overwrites ‘—ref_condition
Default is ‘pairwise’, a keyword to create all pairwise contrasts.
stringpairwiseAlso create an output in Triqler’s format for an alternative manual post-processing with that tool
booleanEnable generation of quality control report by PTXQC? default: ‘false’ since it is still unstable
booleanSpecify a yaml file for the report layout (see PTXQC documentation) (TODO not yet fully implemented)
string