Skip to content

Commit 3cf5d79

Browse files
alchemistmattalchemistmatt
committed
Update documentation and change log
1 parent 2822fcf commit 3cf5d79

File tree

3 files changed

+88
-31
lines changed

3 files changed

+88
-31
lines changed

‎ZippedReleases/ReferenceFiles/Syntax.txt

+24-25
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11

22
Usage: java -Xmx3500M -jar MSGFPlus.jar
3-
-s SpectrumFile (*.mzML, *.mzXML, *.mgf, *.ms2, *.pkl or *_dta.txt)
4-
Spectra should be centroided (see below for MSConvert example). Profile spectra will be ignored.
5-
-d DatabaseFile (*.fasta or *.fa or *.faa)
63
[-conf ConfigurationFile] (Configuration file path; options specified at the command line will override settings in the config file)
74
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)
88
[-decoy DecoyPrefix] (Prefix for decoy protein names; Default: XXX)
99
[-o OutputFile (*.mzid)] (Default: [SpectrumFileName].mzid)
1010
[-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)
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)
1919
This is best set to the number of physical cores in a single NUMA node.
2020
Generally a single NUMA node is 1 physical processor.
2121
The default will try to use hyperthreading cores, which can increase the amount of time this process will take.
2222
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.
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.
3030
[-verbose 0/1] (Console output message verbosity, Default: 0)
3131
0 means Report total progress only
3232
1 means Report total and per-thread progress/status
@@ -38,18 +38,18 @@ Usage: java -Xmx3500M -jar MSGFPlus.jar
3838
1 means CID
3939
2 means ETD
4040
3 means HCD
41-
[-inst MS2DetectorID] (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.
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.
4646
[-mod ModificationFileName] (Modification file; Default: standard amino acids with fixed C+57; only if -mod is not specified)
4747
[-minLength MinPepLength] (Minimum peptide length to consider; Default: 6)
4848
[-maxLength MaxPepLength] (Maximum peptide length to consider; Default: 40)
4949
[-minCharge MinCharge] (Minimum precursor charge to consider if charges are not specified in the spectrum file; Default: 2)
5050
[-maxCharge MaxCharge] (Maximum precursor charge to consider if charges are not specified in the spectrum file; Default: 3)
5151
[-n NumMatchesPerSpec] (Number of matches per spectrum to be reported; Default: 1)
52-
[-addFeatures 0/1] (Include additional features in the output, Default: 0)
52+
[-addFeatures 0/1] (Include additional features in the output (enable this to post-process results with Percolator), Default: 0)
5353
0 means Output basic scores only (Default)
5454
1 means Output additional features
5555
[-ccm ChargeCarrierMass] (Mass of charge carrier; Default: mass of proton (1.00727649))
@@ -60,7 +60,6 @@ Example (high-precision): java -Xmx3500M -jar MSGFPlus.jar -s test.mzML -d IPI_h
6060

6161
Example (low-precision): java -Xmx3500M -jar MSGFPlus.jar -s test.mzML -d IPI_human_3.79.fasta -inst 0 -t 0.5Da,2.5Da -ntt 2 -tda 1 -o testMSGFPlus.mzid -mod Mods.txt
6262

63-
6463
For Thermo .raw files, obtain a centroided .mzML file using MSConvert, which is part of ProteoWizard (http://proteowizard.sourceforge.net/)
6564
MSConvert.exe DatasetName.raw --filter "peakPicking true 1-" --mzML --32
6665

‎docs/Changelog.html

+8
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ <h1 class="pagetitle">MS-GF+ ChangeLog</h1>
1212
<p>
1313
<a href="index.html">MS-GF+ Documentation home</a>
1414
</p>
15+
16+
<p>
17+
<b>v2021.03.22</b>
18+
</p>
19+
<ul>
20+
<li>When displaying parameters, show the value for IgnoreMetCleavage</li>
21+
<li>Update online documentation, including example parameter files</li>
22+
</ul>
1523

1624
<p>
1725
<b>v2021.01.15</b>

‎docs/MSGFPlus.html

+56-6
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@ <h1 class="pagetitle">MS-GF+</h1>
1414

1515
<h1>MS-GF+</h1>
1616

17-
<p>
18-
<a href="MS-GFDB.html" title="MS-GFDB">(How to migrate from MS-GFDB to MS-GF)</a>
19-
</p>
20-
2117
<p>
2218
<a href="Changelog.html" title="MS-GF+ ChangeLog">ChangeLog</a>
2319
</p>
@@ -89,6 +85,8 @@ <h1>MS-GF+</h1>
8985

9086
<span class="code-keyword">[-ccm ChargeCarrierMass]</span> (Mass of charge carrier; <span class="code-object">Default: mass of proton (1.00727649)</span>)
9187

88+
<span class="code-keyword">[-ignoreMetCleavage 0/1]</span> (N-terminal methionine cleavage behavior; <span class="code-object">Default: 0</span>)
89+
9290
<span class="code-keyword">[-maxMissedCleavages Count]</span> (Exclude peptides with more than this number of missed cleavages from the search; <span class="code-object">Default: -1 (no limit)</span>)
9391

9492
<span class="code-keyword">[-numMods Count]</span> (Maximum number of dynamic (variable) modifications per peptide; <span class="code-object">Default: 3</span>)
@@ -121,6 +119,7 @@ <h3>Parameters:</h3>
121119
</ul>
122120
<p class="note"><code>MSConvert.exe --mzML --32 --filter "peakPicking true 1-" DatasetName.raw</code></p>
123121
</li>
122+
124123
<li style="margin-bottom: 10px;">
125124
<b>-d DatabaseFile</b> (*.fasta or *.fa or *.faa) - Required
126125
<ul>
@@ -129,6 +128,7 @@ <h3>Parameters:</h3>
129128
</ul>
130129
<p class="note">If multiple MS-GF+ processes access the same database file, it is strongly recommended to index the database prior to the database search by <a href="BuildSA.html">running BuildSA</a>.</p>
131130
</li>
131+
132132
<li style="margin-bottom: 10px;">
133133
<b>-conf ConfigurationFile</b>
134134
<ul>
@@ -159,6 +159,7 @@ <h3>Parameters:</h3>
159159
<li>E.g. for the input spectrum file "test.mzML", the output will be written to "test.mzid" if this parameter is not specified.</li>
160160
</ul>
161161
</li>
162+
162163
<li style="margin-bottom: 10px;">
163164
<b>-t PrecursorMassTolerance</b> (Default: 20ppm)
164165
<ul>
@@ -167,6 +168,7 @@ <h3>Parameters:</h3>
167168
<li>It is recommended to use a tight tolerance rather than a loose tolerance (e.g. for Orbitrap data, 10ppm or 20ppm usually identifies more spectra than 50ppm).</li>
168169
</ul>
169170
</li>
171+
170172
<li style="margin-bottom: 10px;">
171173
<b>-ti IsotopeErrorRange</b> (Default: 0,1)
172174
<ul>
@@ -176,13 +178,15 @@ <h3>Parameters:</h3>
176178
<li>E.g. <span class="code-keyword"><code>-t 20ppm -ti -1,2</code></span> tests abs(ObservedPepMass - TheoreticalPepMass - n * 1.00335Da) &lt; 20ppm for n = -1, 0, 1, 2</li>
177179
</ul>
178180
</li>
181+
179182
<li style="margin-bottom: 10px;">
180183
<b>-thread NumOfThreads</b> (Default: Number of available cores)
181184
<ul>
182185
<li>Number of concurrent threads to be executed together.</li>
183186
<li>Default value is the number of available logical cores (e.g. 8 for quad-core processor with hyper-threading support).</li>
184187
</ul>
185188
</li>
189+
186190
<li style="margin-bottom: 10px;">
187191
<b>-tasks NumTasks</b> (Default: internally calculated based on inputs)
188192
<ul>
@@ -197,6 +201,7 @@ <h3>Parameters:</h3>
197201
<li>2-3 tasks per thread will use comparably less memory, but may cause the search to take 1.5 to 2 times as long with a 23MB fasta file.</li>
198202
</ul>
199203
</li>
204+
200205
<li style="margin-bottom: 10px;">
201206
<b>-verbose 0/1</b> (Default: 0)
202207
<ul>
@@ -250,6 +255,7 @@ <h3>Parameters:</h3>
250255
<li>If the identifier is 4, MS/MS spectra from the same precursor ion (e.g. CID/ETD pairs, CID/HCD/ETD triplets) will be merged and the &quot;merged&quot; spectrum will be used for searching instead of individual spectra. See Kim et al., MCP 2010 for details.</li>
251256
</ul>
252257
</li>
258+
253259
<li style="margin-bottom: 10px;">
254260
<b>-inst InstrumentID</b>
255261
<ul>
@@ -269,12 +275,13 @@ <h3>Parameters:</h3>
269275
<li>For other HCD spectra, use 1.</li>
270276
</ul>
271277
</li>
278+
272279
<li style="margin-bottom: 10px;">
273280
<b>-e EnzymeID</b> (Default: 1)
274281
<ul>
275282
<li>Enzyme identifier.
276283
<ul>
277-
<li>0: unspecific cleavage</li>
284+
<li>0: unspecific cleavage (cleave after any residue)</li>
278285
<li>1: Trypsin (default)</li>
279286
<li>2: Chymotrypsin</li>
280287
<li>3: Lys-C</li>
@@ -291,6 +298,7 @@ <h3>Parameters:</h3>
291298
<li>For more info, see <a href="examples/enzymes.txt">enzymes.txt</a></li>
292299
</ul>
293300
</li>
301+
294302
<li style="margin-bottom: 10px;">
295303
<b>-p ProtocolID</b> (Default: 0)
296304
<ul>
@@ -338,38 +346,44 @@ <h3>Parameters:</h3>
338346
See an <a href="examples/Mods.txt">example MS-GF+ modification file</a>.</li>
339347
</ul>
340348
</li>
349+
341350
<li style="margin-bottom: 10px;">
342351
<b>-minLength MinPepLength</b> (Default: 6)
343352
<ul>
344353
<li>Minimum length of the peptide to be considered.</li>
345354
</ul>
346355
</li>
356+
347357
<li style="margin-bottom: 10px;">
348358
<b>-maxLength MaxPepLength</b> (Default: 40)
349359
<ul>
350360
<li>Maximum length of the peptide to be considered.</li>
351361
</ul>
352362
</li>
363+
353364
<li style="margin-bottom: 10px;">
354365
<b>-minCharge MinPrecursorCharge</b> (Default: 2)
355366
<ul>
356367
<li>Minimum precursor charge to consider. This parameter is used only for spectra with no charge.</li>
357368
</ul>
358369
</li>
370+
359371
<li style="margin-bottom: 10px;">
360372
<b>-maxCharge MinPrecursorCharge</b> (Default: 3)
361373
<ul>
362374
<li>Maximum precursor charge to consider. This parameter is used only for spectra with no charge.</li>
363375
</ul>
364376
</li>
377+
365378
<li style="margin-bottom: 10px;">
366379
<b>-n NumMatchesPerSpec</b> (Default: 1)
367380
<ul>
368381
<li>Number of peptide matches per spectrum to report.</li>
369382
<li>Expected false discovery rates (EFDRs) will be reported only when this value is 1.</li>
370383
</ul>
371384
</li>
372-
<li>
385+
386+
<li style="margin-bottom: 10px;">
373387
<b>-addFeatures 0/1</b> (Default: 0)
374388
<ul>
375389
<li>If 0, only basic scores are reported.</li>
@@ -383,6 +397,37 @@ <h3>Parameters:</h3>
383397
</li>
384398
</ul>
385399
</li>
400+
401+
<li style="margin-bottom: 10px;">
402+
<b>-ccm ChargeCarrierMass</b> (Default: 1.00727649)
403+
<ul>
404+
<li>Override the default charge carrier mass</li>
405+
</ul>
406+
</li>
407+
408+
<li style="margin-bottom: 10px;">
409+
<b>-ignoreMetCleavage 0/1</b> (Default: 0)
410+
<ul>
411+
<li>0: consider cleavage of methionine from the protein's N-terminus, even when NTT=2</li>
412+
<li>1: disable N-terminal methionine cleavage</li>
413+
</ul>
414+
</li>
415+
416+
<li style="margin-bottom: 10px;">
417+
<b>-maxMissedCleavages Count</b> (Default: -1, meaning no limit)
418+
<ul>
419+
<li>Exclude peptides with more than this number of missed cleavages</li>
420+
</ul>
421+
</li>
422+
423+
<li style="margin-bottom: 10px;">
424+
<b>-numMods Count</b> (Default: 3)
425+
<ul>
426+
<li>Maximum number of dynamic (variable) modifications per peptide</li>
427+
<li>If this value is large and multiple dynamic modifications are defined, the search will be slow (depending on FASTA file size)</li>
428+
</ul>
429+
</li>
430+
386431
</ul>
387432

388433
<h3>MS-GF+ output</h3>
@@ -392,22 +437,27 @@ <h3>MS-GF+ output</h3>
392437
<li style="margin-bottom: 5px;">
393438
<b>MS-GF:RawScore</b>: MS-GF+ raw score of the peptide-spectrum match
394439
</li>
440+
395441
<li style="margin-bottom: 5px;">
396442
<b>MS-GF:DeNovoScore</b><b>:</b> the score of the optimal scoring peptide for the spectrum (not necessary in the database)&nbsp;(MS-GF:RawScore &lt;= MS-GF:DeNovoScore)
397443
</li>
444+
398445
<li style="margin-bottom: 5px;">
399446
<b>MS-GF:SpecEValue</b>: spectral E-value (spectrum level E-value) of the peptide-spectrum match - the lower the better
400447
</li>
448+
401449
<li style="margin-bottom: 5px;">
402450
<b>MS-GF:EValue</b>: database level E-value (expected number of peptides in a random database having equal or better scores than the PSM score) - the lower the better
403451
</li>
452+
404453
<li style="margin-bottom: 5px;">
405454
<b>MS-GF:QValue</b>
406455
<ul>
407456
<li>PSM-level Q-value estimated using the target-decoy approach.</li>
408457
<li>MS-GF:QValue is computed solely based on MS-GF:SpecEValue.</li>
409458
</ul>
410459
</li>
460+
411461
<li style="margin-bottom: 5px;">
412462
<b>MS-GF:PepQValue</b>
413463
<ul>

0 commit comments

Comments
 (0)