|
1 | 1 |
|
2 | 2 | Usage: java -Xmx3500M -jar MSGFPlus.jar |
3 | | - [-conf ConfigurationFile] (Configuration file path; options specified at the command line will override settings in the config file) |
4 | | - Example parameter file is at https://github.com/MSGFPlus/msgfplus/blob/master/docs/examples/MSGFPlus_Params.txt |
5 | | - [-s SpectrumFile] (*.mzML, *.mzXML, *.mgf, *.ms2, *.pkl or *_dta.txt) |
6 | | - Spectra should be centroided (see below for MSConvert example). Profile spectra will be ignored. |
7 | | - [-d DatabaseFile] (*.fasta or *.fa or *.faa) |
8 | | - [-decoy DecoyPrefix] (Prefix for decoy protein names; Default: XXX) |
9 | | - [-o OutputFile (*.mzid)] (Default: [SpectrumFileName].mzid) |
10 | | - [-t PrecursorMassTolerance] (e.g. 2.5Da, 20ppm or 0.5Da,2.5Da; Default: 20ppm) |
11 | | - Use a comma to define asymmetric values. |
12 | | - E.g. "-t 0.5Da,2.5Da" will set 0.5Da to the left (ObservedPepMass < TheoreticalPepMass) |
13 | | - and 2.5Da to the right (ObservedPepMass > TheoreticalPepMass) |
14 | | - [-ti IsotopeErrorRange] (Range of allowed isotope peak errors; Default: 0,1) |
15 | | - Takes into account the error introduced by choosing a non-monoisotopic peak for fragmentation. |
16 | | - The combination of -t and -ti determines the precursor mass tolerance. |
17 | | - E.g. "-t 20ppm -ti -1,2" tests abs(ObservedPepMass - TheoreticalPepMass - n * 1.00335Da) < 20ppm for n = -1, 0, 1, 2. |
18 | | - [-thread NumThreads] (Number of concurrent threads to be executed; Default: Number of available cores) |
19 | | - This is best set to the number of physical cores in a single NUMA node. |
20 | | - Generally a single NUMA node is 1 physical processor. |
21 | | - The default will try to use hyperthreading cores, which can increase the amount of time this process will take. |
22 | | - This is because the part of Scoring param generation that is multithreaded is also I/O intensive. |
23 | | - [-tasks NumTasks] (Override the number of tasks to use on the threads; Default: (internally calculated based on inputs)) |
24 | | - More tasks than threads will reduce the memory requirements of the search, but will be slower (how much depends on the inputs). |
25 | | - 1 <= tasks <= numThreads: will create one task per thread, which is the original behavior. |
26 | | - tasks = 0: use default calculation - minimum of: (threads*3) and (numSpectra/250). |
27 | | - tasks < 0: multiply number of threads by abs(tasks) to determine number of tasks (i.e., -2 means "2 * numThreads" tasks). |
28 | | - One task per thread will use the most memory, but will usually finish the fastest. |
29 | | - 2-3 tasks per thread will use comparably less memory, but may cause the search to take 1.5 to 2 times as long. |
30 | | - [-verbose 0/1] (Console output message verbosity, Default: 0) |
31 | | - 0 means Report total progress only |
32 | | - 1 means Report total and per-thread progress/status |
33 | | - [-tda TDA] (Target decoy strategy, Default: 0) |
34 | | - 0 means Don't search decoy database (Default) |
35 | | - 1 means search the decoy database (forward + reverse proteins) |
36 | | - [-m FragmentationMethodID] (Fragmentation Method, Default: 0) |
37 | | - 0 means as written in the spectrum or CID if no info (Default) |
38 | | - 1 means CID |
39 | | - 2 means ETD |
40 | | - 3 means HCD |
41 | | - [-inst InstrumentID] (0: Low-res LCQ/LTQ (Default), 1: Orbitrap/FTICR/Lumos, 2: TOF, 3: Q-Exactive) |
42 | | - [-e EnzymeID] (0: unspecific cleavage, 1: Trypsin (Default), 2: Chymotrypsin, 3: Lys-C, 4: Lys-N, 5: glutamyl endopeptidase, 6: Arg-C, 7: Asp-N, 8: alphaLP, 9: no cleavage) |
43 | | - [-protocol ProtocolID] (0: Automatic (Default), 1: Phosphorylation, 2: iTRAQ, 3: iTRAQPhospho, 4: TMT, 5: Standard) |
44 | | - [-ntt 0/1/2] (Number of Tolerable Termini, Default: 2) |
45 | | - E.g. For trypsin, 0: non-tryptic, 1: semi-tryptic, 2: fully-tryptic peptides only. |
46 | | - [-mod ModificationFileName] (Modification file; Default: standard amino acids with fixed C+57; only if -mod is not specified) |
47 | | - [-minLength MinPepLength] (Minimum peptide length to consider; Default: 6) |
48 | | - [-maxLength MaxPepLength] (Maximum peptide length to consider; Default: 40) |
49 | | - [-minCharge MinCharge] (Minimum precursor charge to consider if charges are not specified in the spectrum file; Default: 2) |
50 | | - [-maxCharge MaxCharge] (Maximum precursor charge to consider if charges are not specified in the spectrum file; Default: 3) |
51 | | - [-n NumMatchesPerSpec] (Number of matches per spectrum to be reported; Default: 1) |
52 | | - [-addFeatures 0/1] (Include additional features in the output (enable this to post-process results with Percolator), Default: 0) |
53 | | - 0 means Output basic scores only (Default) |
54 | | - 1 means Output additional features |
55 | | - [-ccm ChargeCarrierMass] (Mass of charge carrier; Default: mass of proton (1.00727649)) |
56 | | - [-maxMissedCleavages Count] (Exclude peptides with more than this number of missed cleavages from the search; Default: -1 (no limit)) |
57 | | - [-numMods Count] (Maximum number of dynamic (variable) modifications per peptide; Default: 3) |
| 3 | + [-conf ConfigurationFile] (Configuration file path; options specified at the command line will override settings in the config file) |
| 4 | + An example parameter file is at https://github.com/MSGFPlus/msgfplus/blob/master/docs/examples/MSGFPlus_Params.txt |
| 5 | + Additional parameter files are at https://github.com/MSGFPlus/msgfplus/tree/master/docs/ParameterFiles |
| 6 | + |
| 7 | + [-s SpectrumFile] (*.mzML, *.mzXML, *.mgf, *.ms2, *.pkl or *_dta.txt) |
| 8 | + Spectra should be centroided (see below for MSConvert example). Profile spectra will be ignored. |
| 9 | + |
| 10 | + [-d DatabaseFile] (*.fasta or *.fa or *.faa) |
| 11 | + |
| 12 | + [-decoy DecoyPrefix] (Prefix for decoy protein names; Default: XXX) |
| 13 | + |
| 14 | + [-o OutputFile (*.mzid)] (Default: [SpectrumFileName].mzid) |
| 15 | + |
| 16 | + [-t PrecursorMassTolerance] (e.g. 2.5Da, 20ppm or 0.5Da,2.5Da; Default: 20ppm) |
| 17 | + Use a comma to define asymmetric values. |
| 18 | + E.g. "-t 0.5Da,2.5Da" will set 0.5Da to the left (ObservedPepMass < TheoreticalPepMass) |
| 19 | + and 2.5Da to the right (ObservedPepMass > TheoreticalPepMass) |
| 20 | + |
| 21 | + [-ti IsotopeErrorRange] (Range of allowed isotope peak errors; Default: 0,1) |
| 22 | + Takes into account the error introduced by choosing a non-monoisotopic peak for fragmentation. |
| 23 | + The combination of -t and -ti determines the precursor mass tolerance. |
| 24 | + E.g. "-t 20ppm -ti -1,2" tests abs(ObservedPepMass - TheoreticalPepMass - n * 1.00335Da) < 20ppm for n = -1, 0, 1, 2. |
| 25 | + |
| 26 | + [-thread NumThreads] (Number of concurrent threads to be executed; Default: Number of available cores) |
| 27 | + This is best set to the number of physical cores in a single NUMA node. |
| 28 | + Generally a single NUMA node is 1 physical processor. |
| 29 | + The default will try to use hyperthreading cores, which can increase the amount of time this process will take. |
| 30 | + This is because the part of Scoring param generation that is multithreaded is also I/O intensive. |
| 31 | + |
| 32 | + [-tasks NumTasks] (Override the number of tasks to use on the threads; Default: internally calculated based on inputs) |
| 33 | + More tasks than threads will reduce the memory requirements of the search, but will be slower (how much depends on the inputs). |
| 34 | + 1 <= tasks <= numThreads: will create one task per thread, which is the original behavior. |
| 35 | + tasks = 0: use default calculation - minimum of: (threads*3) and (numSpectra/250). |
| 36 | + tasks < 0: multiply number of threads by abs(tasks) to determine number of tasks (i.e., -2 means "2 * numThreads" tasks). |
| 37 | + One task per thread will use the most memory, but will usually finish the fastest. |
| 38 | + 2-3 tasks per thread will use comparably less memory, but may cause the search to take 1.5 to 2 times as long. |
| 39 | + |
| 40 | + [-verbose 0/1] (Console output message verbosity; Default: 0) |
| 41 | + 0: Report total progress only |
| 42 | + 1: Report total and per-thread progress/status |
| 43 | + |
| 44 | + [-tda 0/1] (Target decoy strategy; Default: 0) |
| 45 | + 0: Don't use a decoy database |
| 46 | + 1: Search with a decoy database (forward + reverse proteins) |
| 47 | + |
| 48 | + [-m FragmentationMethodID] (Fragmentation Method; Default: 0) |
| 49 | + 0: As written in the spectrum or CID if no info |
| 50 | + 1: CID |
| 51 | + 2: ETD |
| 52 | + 3: HCD |
| 53 | + 4: UVPD |
| 54 | + |
| 55 | + [-inst InstrumentID] (Instrument ID; Default: 0) |
| 56 | + 0: Low-res LCQ/LTQ |
| 57 | + 1: Orbitrap/FTICR/Lumos |
| 58 | + 2: TOF |
| 59 | + 3: Q-Exactive |
| 60 | + |
| 61 | + [-e EnzymeID] (Enzyme ID; Default: 1) |
| 62 | + 0: Unspecific cleavage |
| 63 | + 1: Trypsin |
| 64 | + 2: Chymotrypsin |
| 65 | + 3: Lys-C |
| 66 | + 4: Lys-N |
| 67 | + 5: glutamyl endopeptidase |
| 68 | + 6: Arg-C |
| 69 | + 7: Asp-N |
| 70 | + 8: alphaLP |
| 71 | + 9: no cleavage |
| 72 | + |
| 73 | + [-protocol ProtocolID] (Protocol ID; Default: 0) |
| 74 | + 0: Automatic |
| 75 | + 1: Phosphorylation |
| 76 | + 2: iTRAQ |
| 77 | + 3: iTRAQPhospho |
| 78 | + 4: TMT |
| 79 | + 5: Standard |
| 80 | + |
| 81 | + [-ntt 0/1/2] (Number of Tolerable Termini; Default: 2) |
| 82 | + When EnzymeID is 1 (trypsin), |
| 83 | + 2: Only search for fully-tryptic peptides |
| 84 | + 1: Search for semi-tryptic and fully-tryptic peptides |
| 85 | + 0: Non-tryptic search |
| 86 | + |
| 87 | + [-mod ModificationFileName] (Modification file; Default: standard amino acids with fixed C+57; only if -mod is not specified) |
| 88 | + |
| 89 | + [-minLength MinPepLength] (Minimum peptide length to consider; Default: 6) |
| 90 | + |
| 91 | + [-maxLength MaxPepLength] (Maximum peptide length to consider; Default: 40) |
| 92 | + |
| 93 | + [-minCharge MinCharge] (Minimum precursor charge to consider if charges are not specified in the spectrum file; Default: 2) |
| 94 | + |
| 95 | + [-maxCharge MaxCharge] (Maximum precursor charge to consider if charges are not specified in the spectrum file; Default: 3) |
| 96 | + |
| 97 | + [-n NumMatchesPerSpec] (Number of matches per spectrum to be reported; Default: 1) |
| 98 | + |
| 99 | + [-addFeatures 0/1] (Include additional features in the output; enable this to post-process results with Percolator; Default: 0) |
| 100 | + 0: Output basic scores only |
| 101 | + 1: Output additional features |
| 102 | + |
| 103 | + [-ccm ChargeCarrierMass] (Mass of charge carrier; Default: mass of a proton, 1.00727649) |
| 104 | + |
| 105 | + [-ignoreMetCleavage 0/1] (N-terminal methionine cleavage behavior; Default: 0) |
| 106 | + |
| 107 | + [-maxMissedCleavages Count] (Exclude peptides with more than this number of missed cleavages from the search; Default: -1, meaning no limit) |
| 108 | + |
| 109 | + [-minNumPeaks Count] (Minimum number of ions a spectrum must have to be examined; Default: 10) |
| 110 | + |
| 111 | + [-iso NumIsoforms] (Number of isoforms to consider per peptide; Default: 128) |
| 112 | + |
| 113 | + [-numMods Count] (Maximum number of dynamic (variable) modifications per peptide; Default: 3) |
| 114 | + |
| 115 | + [-allowDenseCentroidedPeaks 0/1] (Default: 0 (disabled); 1: (for mzML/mzXML input only) allows inclusion of spectra with high-density centroid data in the search) |
| 116 | + MS-GF+ checks the distance between consecutive peaks in the spectrum, and if the median distance is less than 50 ppm, they are considered profile spectra regardless of the value provided in mzML and mzXML files. |
| 117 | + This parameter allows overriding this check when the mzML/mzXML file says the spectrum is centroided. |
58 | 118 |
|
59 | 119 | Example (high-precision): java -Xmx3500M -jar MSGFPlus.jar -s test.mzML -d IPI_human_3.79.fasta -inst 1 -t 20ppm -ti -1,2 -ntt 2 -tda 1 -o testMSGFPlus.mzid -mod Mods.txt |
60 | 120 |
|
|
0 commit comments