nf-core/metaboigniter
Pre-processing of mass spectrometry-based metabolomics data with quantification and identification based on MS1 and MS2 data.
1.0.1). The latest
stable release is
2.0.1
.
General options that affect the whole pipeline
Output directory for results
string./resultsEmail address for completion summary
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$Parameters used to tune library creation (only set if you want to do library idnetification)
set whether you want to do quantification with OpenMS (openms) or XCMS (xcms) in negative ionization (for library)
stringControls how to perform IPO
stringQuantification methods for IPO
stringcentWavelowest level of noise
number1000highest level of noise
numberlowest level of signal to noise threshold
number10highest level of signal to noise threshold
number10Function for centering the mz
stringwMeanIntegration method
number1logical, if TRUE a Gaussian is fitted
booleanlower minimum width of peaks
number12higher minimum width of peaks
number28lower maximum width of peaks
number35higher maximum width of peaks
number65lower ppm mass deviation
number17higher ppm mass deviation
number32lower minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number-0.001higher minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number0.01maximum charge of molecules (only used in individual setting)
number1ppm mass deviation for adducts (only used in individual setting)
number10lower value of K in ‘prefilter_library_neg=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >_library_neg= ‘I’.
number3higher value of K in ‘prefilter_library_neg=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >_library_neg= ‘I’.
number3lower I in prefilter
number100higher I in prefilter
number100number of cores used in IPO
number5lower Penalty for Gap opening
numberhigher Penalty for Gap opening
number0.4lower Penalty for Gap enlargement
number2.1higher Penalty for Gap enlargement
number2.7lower step size (in m/z) to use for profile generation from the raw data files
number0.7higher step size (in m/z) to use for profile generation from the raw data files
number1lower Responsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1higher Responsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1lower Local weighting applied to diagonal moves in alignment.
number2higher Local weighting applied to diagonal moves in alignment.
number2lower Local weighting applied to gap moves in alignment.
number1higher Local weighting applied to gap moves in alignment.
number1Local rather than global alignment
numberlower bandwidth (consider something like retention time differences)
number22higher bandwidth (consider something like retention time differences)
number38lower minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.3higher minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.7lower mz width (mz differences)
number0.015higher mz width (mz differences)
number0.035lower minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1higher minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1lower maximum number of groups to identify in a single m/z slice
number50higher maximum number of groups to identify in a single m/z slice
number50DistFunc function: cor (Pearson’s R) or cor_opt (default, calculate only 10% diagonal band of distance matrix, better runtime), cov (covariance), prd (product), euc (Euclidean distance)
stringcor_optOnly obiwarp is supported
stringobiwarpmass trace deviation in ppm
number10lower width of peaks
number5highest width of peaks
number30level of noise
number1000minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number-0.001signal to noise ratio cutoff, definition see below.
number10K in ‘prefilter=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >= ‘I’.
number3I in prefilter
number100Function to calculate the m/z center of the feature: ‘wMean’ intensity weighted mean of the feature m/z values, ‘mean’ mean of the feature m/z values, ‘apex’ use m/z value at peak apex, ‘wMeanApex3’ intensity weighted mean of the m/z value at peak apex and the m/z value left and right of it, ‘meanApex3’ mean of the m/z value at peak apex and the m/z value left and right of it.
stringwMeanIntegration method. If ‘=1’ peak limits are found through descent on the mexican hat filtered data, if ‘=2’ the descent is done on the real data. Method 2 is very accurate but prone to noise, while method 1 is more robust to noise but less exact.
number1logical, if TRUE a Gaussian is fitted
booleanA name for the class of sample
stringSamplesigma value for grouping the peaks across chromatogram
number8full width at half maximum for finding overlaping peaks
number0.6which intensity value to use
stringmaxoppm deviation between theoritical adduct mass and the experimental one
number10this has to be negative (for testing only)!
stringnegativenumber of changes to consider (most often 1 is enough)
number1ppm deviation when mapping MS2 parent ion to a mass trace
number10rt difference (in second) for mapping MS2 parent ion to a mass trace (the mass trace is a range, star and end of the trace)
number5Parameters used to characterize the internal library
name of the column showing which raw files contain which metabolite in the library_description_neg csv file
stringrawFilename of the column showing id of the metabolites in the library_description_neg csv file
stringHMDB.YMDB.IDname of the compount column in the library_description_neg csv file
stringPRIMARY_NAMEname of the mz column in the library_description_neg csv file
stringmz“f” or “c”, showing whether the Feature range or centroid of the feature should be used for mapping
stringNumber of cores for mapping the features
number1ppm error for mapping the library characterization masses to the experimental one
number10Parameters that control how the results are outputted
relative difference of mass of the ID hit compare to a mass trace (ppm)
number10retention time difference of ID to mass trace (second)
number5should we impute adduct and different chance states with the same ID
booleantrueClass of the samples (used for statistics and coverage calculations)
stringClasswhat class of samples do you want to keep (anything not matching this in the Class column will be removed)
stringSampleyou want to rename the files
booleantruewhich column of the phenotype file to use for renaming
stringrenamedo only want to see the identified mass traces or everything?
booleando you have technical replicates you want to average ?
booleanwhich column of the phenotype file show the technical replicates
stringrepshould we log2 the output
booleantrueany mass trace having more pecentage of the missing value will be removed
number50do you want to normalize the data set to ‘NA’ if you don’t want normalization
string1Parameters specific to CFM-ID
path to a csv file containing your database
stringnumber of cores that cfm can use
number2name of the column in the database for id of the molecules
stringIdentifiername of the column in the database for smile of the molecules
stringSMILESname of the column in the database for mass of the molecules
stringMonoisotopicMassname of the column in the database for name of the molecules
stringNamename of the column in the database for inchi of the molecules
stringInChIParameters only for MetFrag
path to a csv file containing your database
stringnumber of cores that metfrag can use
number2Parameters only for CSI:FINGERID
IMPORTANT: we don’t support database file for csi:fingerid. You will need to provide what database to use here, the rest of the parameters will be taken from there parameter file
stringhmdbnumber of cores that csi can use
number2number of seconds that each csi ion can rum (time limit)
number600Parameters that will be used in all the search engines
ppm deviation when mapping MS2 parent ion to a mass trace
number10rt difference (in second) for mapping MS2 parent ion to a mass trace (the mass trace is a range, star and end of the trace)
number5relative mass tolerance of the precursor (ppm)
number10relative mass tolerance of the fragment ions (ppm)
number20absolute mass tolerance of the fragment ions
number0.05type of database to use (see metaboIGNITER guide)
stringLocalCSVionization method. This has to be neg (only for testing at this stage)
stringnegadduct rules (primary or extended)
stringions with less that this number will be removed
number2Settings for CAMERA to detect adducts and isotopes
sigma value for grouping the peaks across chromatogram
number8full width at half maximum for finding overlaping peaks
number0.6which intensity value to use
stringmaxoppm deviation between theoritical adduct mass and the experimental one
number10this has to be negative (for testing only)!
stringnegativenumber of changes to consider (most often 1 is enough)
number1Parameters to use for performing QC, blank and dilution filtering
set to true if you want to remove signal from blank
booleanmethod of sumarization of signal in blank samples
stringmaxName of the class of the blank samples
stringBlankName of the class of the biological samples
stringSampleset to T to compare blanks only to rest of the samples
stringWhether blank filtereing should be done or not?
booleanThis series will used for calculation of correlation. For example if this parameter is set like 1,2,3 and the class of dilution trends is set as D1,D2,D3 the following the pairs will be used for calculating the correlation: (D1,1),(D2,2),(D3,3)
string0.5,1,2,4The class of the samples represneting dilution. This has to be separated by comma!
stringD1,D2,D3,D4p-value of the correlation. Anything higher than this will be removed!
number0.05minimum expected correlation. Aniything lower than this will be removed!
number-1If the tool should consider absolute correlation rather than the typical one from [-1 to 1] (F or T)
stringselect to whether perfrom cv filtering or not
booleanclass of your QC samples
stringQCMaximum coefficient of variation you expect. Anything higher than this will be removed!
number0.3Parameters for quantification
set whether you want to do quantification with OpenMS (openms) or XCMS (xcms) in negative ionization
stringcontrols how to perform IPO possible values: “none”: don’t perform IPO, “global”: performs IPO on all or selected number of samples. “global_quant”: perform IPO only for quantification (not retention time correction and grouping), “local”: performs IPO on individual samples one at the time. “local_quant”: performs IPO on individual samples only for quantification, “local_RT”: performs IPO on only for retention time correction and grouping.
stringPerforms IPO on all the samples irrespective of the class they have
booleanIf ipo_allSamples_neg is false, one must pass the phenotype file to select sample. This parameter select the column of the phenotype file.
stringClassSelects the files only with this value in the columnToSelect column
stringQCQuantification methods for IPO. Only centWave is supported at this stage.
stringcentWavelowest level of noise
numberhighest level of noise
numberlowest level of signal to noise threshold
number10highest level of signal to noise threshold
number10Function for centering the mz
stringwMeanIntegration method. If ‘=1’ peak limits are found through descent on the mexican hat filtered data, if ‘=2’ the descent is done on the real data. Method 2 is very accurate but prone to noise, while method 1 is more robust to noise but less exact.
number1logical, if TRUE a Gaussian is fitte
booleanlower minimum width of peaks
number12higher minimum width of peaks
number28lower maximum width of peaks
number35higher maximum width of peaks
number65lower ppm mass deviation
number17higher ppm mass deviation
number32lower minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number-0.001higher minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number0.01maximum charge of molecules (only used in individual setting)
number1ppm mass deviation for adducts (only used in individual setting)
number10lower value of K in ‘prefilter_neg=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >_neg= ‘I’.
number3higher value of K in ‘prefilter_neg=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >_neg= ‘I’.
number3lower I in prefilter
number100higher I in prefilter
number100number of cores used in IPO
number5lower Penalty for Gap opening
numberhigher Penalty for Gap opening
number0.4lower Penalty for Gap enlargement
number2.1higher Penalty for Gap enlargement
number2.7lower step size (in m/z) to use for profile generation from the raw data files
number0.7higher step size (in m/z) to use for profile generation from the raw data files
number1lower Responsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1higher Responsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1lower Local weighting applied to diagonal moves in alignment
number2higher Local weighting applied to diagonal moves in alignment
number2lower Local weighting applied to gap moves in alignment
number1higher Local weighting applied to gap moves in alignment
number1Local rather than global alignment
numberlower bandwidth (consider something like retention time differences)
number22higher bandwidth (consider something like retention time differences)
number38lower minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.3higher minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.7lower mz width (mz differences)
number0.015higher mz width (mz differences)
number0.035lower minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1higher minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1lower maximum number of groups to identify in a single m/z slice
number50higher maximum number of groups to identify in a single m/z slice
number50DistFunc function: cor (Pearson’s R) or cor_opt (default, calculate only 10% diagonal band of distance matrix, better runtime), cov (covariance), prd (product), euc (Euclidean distance)
stringcor_optOnly obiwarp is supported
stringobiwarpmasstrance deviation in ppm
number10lower width of peaks
number5highest width of peaks
number30level of noise
number1000minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number-0.001signal to noise ratio cutoff, definition see below.
number10K in ‘prefilter=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >= ‘I’.
number3I in prefilter
number100Function to calculate the m/z center of the feature: ‘wMean’ intensity weighted mean of the feature m/z values, ‘mean’ mean of the feature m/z values, ‘apex’ use m/z value at peak apex, ‘wMeanApex3’ intensity weighted mean of the m/z value at peak apex and the m/z value left and right of it, ‘meanApex3’ mean of the m/z value at peak apex and the m/z value left and right of it.
stringwMeanIntegration method. If ‘=1’ peak limits are found through descent on the mexican hat filtered data, if ‘=2’ the descent is done on the real data. Method 2 is very accurate but prone to noise, while method 1 is more robust to noise but less exact.
number1logical, if TRUE a Gaussian is fitted
booleanname of the column in the phenotype_design_neg showing class information of the samples
stringClassA name for the class of sample
stringSamplestep size (in m/z) to use for profile generation from the raw data files
number1the index of the sample all others will be aligned to. If center==NULL, the sample with the most peaks is chosen as default.
stringNULLResponsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1DistFunc function: cor (Pearson’s R) or cor_opt (default, calculate only 10% diagonal band of distance matrix, better runtime), cov (covariance), prd (product), euc (Euclidean distance)
stringPenalty for Gap opening
stringNULLPenalty for Gap enlargement
stringNULLLocal weighting applied to diagonal moves in alignment
number2Local weighting applied to gap moves in alignment
number1Local rather than global alignment
numberbandwidth (consider something like retention time differences)
number15mz width (mz differences)
number0.005minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.5minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1maximum number of groups to identify in a single m/z slice
number50Parameters used to tune library creation (only set if you want to do library idnetification)
set whether you want to do quantification with OpenMS (openms) or XCMS (xcms) in positive ionization (for library)
stringcontrols how to perform IPO possible values: “none”: don’t perform IPO, “global”: performs IPO on all or selected number of samples. “local”: performs IPO on individual samples one at the time.
stringQuantification methods for IPO. Only centWave is supported at this stage.
stringcentWavelowest level of noise
numberhighest level of noise
numberlowest level of signal to noise threshold
number10highest level of signal to noise threshold
number10Function for centering the mz
stringwMeanIntegration method. If ‘=1’ peak limits are found through descent on the mexican hat filtered data, if ‘=2’ the descent is done on the real data. Method 2 is very accurate but prone to noise, while method 1 is more robust to noise but less exact.
number1logical, if TRUE a Gaussian is fitte
booleanlower minimum width of peaks
number12higher minimum width of peaks
number28lower maximum width of peaks
number35higher maximum width of peaks
number65lower ppm mass deviation
number17higher ppm mass deviation
number32lower minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number-0.001higher minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number0.01maximum charge of molecules (only used in individual setting)
number1ppm mass deviation for adducts (only used in individual setting)
number10lower value of K in ‘prefilter_library_pos=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >_library_pos= ‘I’.
number3higher value of K in ‘prefilter_library_pos=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >_library_pos= ‘I’.
number3lower I in prefilter
number100higher I in prefilter
number100number of cores used in IPO
number5lower Penalty for Gap opening
numberhigher Penalty for Gap opening
number0.4lower Penalty for Gap enlargement
number2.1higher Penalty for Gap enlargement
number2.7lower step size (in m/z) to use for profile generation from the raw data files
number0.7higher step size (in m/z) to use for profile generation from the raw data files
number1lower Responsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1higher Responsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1lower Local weighting applied to diagonal moves in alignment.
number2higher Local weighting applied to diagonal moves in alignment.
number2lower Local weighting applied to gap moves in alignment.
number1higher Local weighting applied to gap moves in alignment.
number1Local rather than global alignment
numberlower bandwidth (consider something like retention time differences)
number22higher bandwidth (consider something like retention time differences)
number38lower minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.3higher minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.7lower mz width (mz differences)
number0.015higher mz width (mz differences)
number0.035lower minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1higher minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1lower maximum number of groups to identify in a single m/z slice
number50higher maximum number of groups to identify in a single m/z slice
number50DistFunc function: cor (Pearson’s R) or cor_opt (default, calculate only 10% diagonal band of distance matrix, better runtime), cov (covariance), prd (product), euc (Euclidean distance)
stringOnly obiwarp is supported
stringobiwarpmass trace deviation in ppm
number10lower width of peaks
number5highest width of peaks
number30level of noise
number1000minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number-0.001signal to noise ratio cutoff, definition see below.
number10K in ‘prefilter=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >= ‘I’.
number3I in prefilter
number100Function to calculate the m/z center of the feature: ‘wMean’ intensity weighted mean of the feature m/z values, ‘mean’ mean of the feature m/z values, ‘apex’ use m/z value at peak apex, ‘wMeanApex3’ intensity weighted mean of the m/z value at peak apex and the m/z value left and right of it, ‘meanApex3’ mean of the m/z value at peak apex and the m/z value left and right of it.
stringwMeanIntegration method. If ‘=1’ peak limits are found through descent on the mexican hat filtered data, if ‘=2’ the descent is done on the real data. Method 2 is very accurate but prone to noise, while method 1 is more robust to noise but less exact.
number1logical, if TRUE a Gaussian is fitted
booleanA name for the class of sample
stringSamplesigma value for grouping the peaks across chromatogram
number8full width at half maximum for finding overlaping peaks
number0.6which intensity value to use
stringmaxoppm deviation between theoritical adduct mass and the experimental one
number10this has to be positive (for testing only)!
stringpositivenumber of changes to consider (most often 1 is enough)
number1ppm deviation when mapping MS2 parent ion to a mass trace
number10rt difference (in second) for mapping MS2 parent ion to a mass trace (the mass trace is a range, star and end of the trace)
number5Parameters used to characterize the internal library
name of the column showing which raw files contain which metabolite in the library_description_pos csv file
stringrawFilename of the column showing id of the metabolites in the library_description_pos csv file
stringHMDB.YMDB.IDname of the compount column in the library_description_pos csv file
stringPRIMARY_NAMEname of the mz column in the library_description_pos csv file
stringmz“f” or “c”, showing whether the Feature range or centroid of the feature should be used for mapping
stringNumber of cores for mapping the features
number1ppm error for mapping the library characterization masses to the experimental one
number10Parameters that control how the results are outputted
relative difference of mass of the ID hit compare to a mass trace (ppm)
number10retention time difference of ID to mass trace (second)
number5should we impute adduct and different chance states with the same ID
booleantrueClass of the samples (used for statistics and coverage calculations)
stringClasswhat class of samples do you want to keep (anything not matching this in the Class column will be removed)
stringSampleyou want to rename the files
booleantruewhich column of the phenotype file to use for renaming
stringrenamedo only want to see the identified mass traces or everything?
booleando you have technical replicates you want to average ?
booleanwhich column of the phenotype file show the technical replicates
stringrepshould we log2 the output
booleantrueany mass trace having more pecentage of the missing value will be removed
number50do you want to normalize the data set to ‘NA’ if you don’t want normalization
string1Parameters specific to CFM-ID
path to a csv file containing your database
stringnumber of cores that cfm can use
number2name of the column in the database for id of the molecules
stringIdentifiername of the column in the database for smile of the molecules
stringSMILESname of the column in the database for mass of the molecules
stringMonoisotopicMassname of the column in the database for name of the molecules
stringNamename of the column in the database for inchi of the molecules
stringInChIParameters only for MetFrag
path to a csv file containing your database
stringnumber of cores that metfrag can use
number2Parameters only for CSI:FINGERID
IMPORTANT: we don’t support database file for csi:fingerid. You will need to provide what database to use here, the rest of the parameters will be taken from there parameter file
stringhmdbnumber of cores that csi can use
number2number of seconds that each csi ion can rum (time limit)
number600Parameters that will be used in all the search engines
ppm deviation when mapping MS2 parent ion to a mass trace
number10rt difference (in second) for mapping MS2 parent ion to a mass trace (the mass trace is a range, star and end of the trace)
number5relative mass tolerance of the precursor (ppm)
number10relative mass tolerance of the fragment ions (ppm)
number20absolute mass tolerance of the fragment ions
number0.05type of database to use (see metaboIGNITER guide)
stringLocalCSVionization method. This has to be pos (only for testing at this stage)
stringposadduct rules (primary or extended)
stringions with less that this number will be removed
number2Settings for CAMERA to detect adducts and isotopes
sigma value for grouping the peaks across chromatogram
number8full width at half maximum for finding overlaping peaks
number0.6which intensity value to use
stringmaxoppm deviation between theoritical adduct mass and the experimental one
number10this has to be positive (for testing only)!
stringpositivenumber of changes to consider (most often 1 is enough)
number1Parameters to use for performing QC, blank and dilution filtering
set to true if you want to remove signal from blank
booleanmethod of sumarization of signal in blank samples. Must be one of ‘max’, ‘mean’ or ‘median’. For example, if ‘max’ is selected, a signal will be removed if it maximum abundance in the blank samples is higher than maximum abundance in biological samples.
stringmaxName of the class of the blank samples. This must show the class of blank samples exactly as you refer to them in your phenotype file
stringBlankName of the class of the biological samples
stringSampleset to T to compare the blanks only to rest of the samples. If F, the blank signals will be compared with the samples with class sample_blankfilter_pos_xcms
stringTSelect whether you want to do dilution filtering
booleanThis series will used for calculation of correlation. For example if this parameter is set like 1,2,3 and the class of dilution trends is set as D1,D2,D3 the following the pairs will be used for calculating the correlation: (D1,1),(D2,2),(D3,3)
string0.5,1,2,4The class of the samples represneting dilution. This has to be separated by comma! The samples are correlated to the exact order of the sequence provided here
stringD1,D2,D3,D4p-value of the correlation. Anything higher than this will be removed!
number0.05minimum expected correlation. Aniything lower than this will be removed!
number-1If the tool should consider absolute correlation rather than the typical one from [-1 to 1] (F or T)
stringselect to whether perfrom cv filtering or not
booleanclass of your QC samples
stringQCMaximum coefficient of variation you expect. Anything higher than this will be removed!
number0.3Parameters for quantification
set whether you want to do quantification with OpenMS (openms) or XCMS (xcms) in positive ionization
stringcontrols how to perform IPO possible values: “none”: don’t perform IPO, “global”: performs IPO on all or selected number of samples. “global_quant”: perform IPO only for quantification (not retention time correction and grouping), “local”: performs IPO on individual samples one at the time. “local_quant”: performs IPO on individual samples only for quantification, “local_RT”: performs IPO on only for retention time correction and grouping.
stringPerforms IPO on all the samples irrespective of the class they have
booleanIf ipo_allSamples_pos is false, one must pass the phenotype file to select sample. This parameter select the column of the phenotype file.
stringClassSelects the files only with this value in the columnToSelect column
stringQCQuantification methods for IPO. Only centWave is supported at this stage.
stringcentWavelowest level of noise
numberhighest level of noise
numberlowest level of signal to noise threshold
number10highest level of signal to noise threshold
number10Function for centering the mz
stringwMeanIntegration method. If ‘=1’ peak limits are found through descent on the mexican hat filtered data, if ‘=2’ the descent is done on the real data. Method 2 is very accurate but prone to noise, while method 1 is more robust to noise but less exact.
number1logical, if TRUE a Gaussian is fitte
booleanlower minimum width of peaks
number12higher minimum width of peaks
number28lower maximum width of peaks
number35higher maximum width of peaks
number65lower ppm mass deviation
number17higher ppm mass deviation
number32lower minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number-0.001higher minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number0.01maximum charge of molecules (only used in individual setting)
number1ppm mass deviation for adducts (only used in individual setting)
number10lower value of K in ‘prefilter_pos=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >_pos= ‘I’.
number3higher value of K in ‘prefilter_pos=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >_pos= ‘I’.
number3lower I in prefilter
number100higher I in prefilter
number100number of cores used in IPO
number5lower Penalty for Gap opening
numberhigher Penalty for Gap opening
number0.4lower Penalty for Gap enlargement
number2.1higher Penalty for Gap enlargement
number2.7lower step size (in m/z) to use for profile generation from the raw data files
number0.7higher step size (in m/z) to use for profile generation from the raw data files
number1lower Responsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1higher Responsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1lower Local weighting applied to diagonal moves in alignment
number2higher Local weighting applied to diagonal moves in alignment
number2lower Local weighting applied to gap moves in alignment
number1higher Local weighting applied to gap moves in alignment
number1Local rather than global alignment
numberlower bandwidth (consider something like retention time differences)
number22higher bandwidth (consider something like retention time differences)
number38lower minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.3higher minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.7lower mz width (mz differences)
number0.015higher mz width (mz differences)
number0.035lower minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1higher minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1lower maximum number of groups to identify in a single m/z slice
number50higher maximum number of groups to identify in a single m/z slice
number50DistFunc function: cor (Pearson’s R) or cor_opt (default, calculate only 10% diagonal band of distance matrix, better runtime), cov (covariance), prd (product), euc (Euclidean distance)
stringcor_optOnly obiwarp is supported
stringobiwarpmasstrance deviation in ppm
number10lower width of peaks
number5highest width of peaks
number30level of noise
number1000minimum difference in m/z for peaks with overlapping retention times, can be negative to allow overlap
number-0.001signal to noise ratio cutoff, definition see below.
number10K in ‘prefilter=c(k,I)’. Prefilter step for the first phase. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >= ‘I’.
number3I in prefilter
number100Function to calculate the m/z center of the feature: ‘wMean’ intensity weighted mean of the feature m/z values, ‘mean’ mean of the feature m/z values, ‘apex’ use m/z value at peak apex, ‘wMeanApex3’ intensity weighted mean of the m/z value at peak apex and the m/z value left and right of it, ‘meanApex3’ mean of the m/z value at peak apex and the m/z value left and right of it.
stringwMeanIntegration method. If ‘=1’ peak limits are found through descent on the mexican hat filtered data, if ‘=2’ the descent is done on the real data. Method 2 is very accurate but prone to noise, while method 1 is more robust to noise but less exact.
number1logical, if TRUE a Gaussian is fitted
booleanname of the column in the phenotype_design_pos showing class information of the samples
stringClassA name for the class of sample
stringSamplestep size (in m/z) to use for profile generation from the raw data files
number1the index of the sample all others will be aligned to. If center==NULL, the sample with the most peaks is chosen as default.
stringNULLResponsiveness of warping. 0 will give a linear warp based on start and end points. 100 will use all bijective anchors
number1DistFunc function: cor (Pearson’s R) or cor_opt (default, calculate only 10% diagonal band of distance matrix, better runtime), cov (covariance), prd (product), euc (Euclidean distance)
stringPenalty for Gap opening
stringNULLPenalty for Gap enlargement
stringNULLLocal weighting applied to diagonal moves in alignment
number2Local weighting applied to gap moves in alignment
number1Local rather than global alignment
numberbandwidth (consider something like retention time differences)
number15mz width (mz differences)
number0.005minimum fraction of samples necessary in at least one of the sample groups for it to be a valid group
number0.5minimum number of samples necessary in at least one of the sample groups for it to be a valid group
number1maximum number of groups to identify in a single m/z slice
number50Input files includes mzML files and settings for performing identification using internal library
if you have already charaztrized your negative library set this to true and specify the path for library_charactrization_file_neg
booleanpath to the file from charaztrized library (negative)
stringPath to a folder containing library mzML files used for doing adduct calcculation (MS1 data in megative ionization method)
stringPath to a folder containing mzML files used for doing identification (MS2 data in negative ionization method)
stringPath to a csv file containing description of the library for negative (see the help)
stringInput files includes mzML files and settings for performing identification using internal library
if you have already charaztrized your positive library set this to true and specify the path for library_charactrization_file_pos
booleanpath to the file from charaztrized library (positive)
stringPath to a folder containing library mzML files used for doing adduct calcculation (MS1 data in positive ionization method)
stringPath to a folder containing mzML files used for doing identification (MS2 data in positive ionization method)
stringPath to a csv file containing description of the library for positive (see the help)
stringInput files includes mzML files for performing identification
ath to a folder containing mzML files used for doing identification (MS2 data in positive ionization method)
stringPath to a folder containing mzML files used for doing identification (MS2 data in negative ionization method)
stringUsed to control functionality of the workflow e.g identification, quantification etc
set to true to publish all the middle stages
booleanSet to false if you don’t want to do identification. You will not require to set MS2 related parameters if you set this to false
booleanShould Metfrag be used for doing identification?
booleanShould CSI:FingerID be used for doing identification?
booleanShould CFM-ID be used for doing identification?
booleanShould an internal library be used for doing identification?
booleanYou can either set to ‘pos’ (only positive), ‘neg’ (only negative), ‘both’ (both positive and negative).
stringSet to true if your data is in profile mode (only for quantification!)
booleanUsed for peak picking and feature detection
Path to the ini file for PeakPickerHiRes
string$baseDir/assets/openms/openms_peak_picker_ini_pos.iniPath to the ini file for PeakPickerHiRes
string$baseDir/assets/openms/openms_peak_picker_ini_neg.iniPath to the ini file for OpenMS FeatureFinderMetabo in positive mode
string$baseDir/assets/openms/openms_feature_finder_metabo_ini_pos.iniPath to the ini file for OpenMS FeatureFinderMetabo in negative mode
string$baseDir/assets/openms/openms_feature_finder_metabo_ini_neg.iniPath to the ini file for PeakPickerHiRes (for library)
string$baseDir/assets/openms/openms_peak_picker_lib_ini_pos.iniPath to the ini file for PeakPickerHiRes (for library)
string$baseDir/assets/openms/openms_peak_picker_lib_ini_neg.iniPath to the ini file for OpenMS FeatureFinderMetabo in positive mode (for library)
string$baseDir/assets/openms/openms_feature_finder_metabo_lib_ini_pos.iniPath to the ini file for OpenMS FeatureFinderMetabo in negative mode (for library)
string$baseDir/assets/openms/openms_feature_finder_metabo_lib_ini_neg.iniInput files includes mzML files for performing quantification
Path to a folder containing mzML files used for doing quantification (MS1 data in positive ionization method)
stringPath to a folder containing mzML files used for doing quantification (MS1 data in negative ionization method)
stringPath to a csv file containing the experimental design (MS1 data in positive ionization method)
stringPath to a csv file containing the experimental design (MS1 data in negative ionization method)
stringLess 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.
booleanDo 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.
number16Maximum 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.
string