Skip to content

Commit

Permalink
Update version, changelog, and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
FarmGeek4Life committed Jan 28, 2017
1 parent 3ab9eba commit 00643b0
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 3 deletions.
20 changes: 20 additions & 0 deletions doc/Changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ <h1 class="pagetitle">MS-GF+ ChangeLog</h1>
<a href="index.html">MS-GF+ Documentation home</a>
</p>

<p>
<b>01/27/2017 v2017.01.27</b>
</p>
<ul>
<li>Reduce the number of exceptions seen when a thread exits with an exception - There were multiple exceptions being displayed that were the result of killing the other threads.</li>
<li>Change how the overall progress reporting and exception handling is managed, to minimize the thread overhead burden.</li>
<li>Allow the user to specify a number of tasks on the command line using "-tasks n", and modify the default calculation. The previous default had a hard-coded limit of 64, and multiplied the number of threads by 10; new default removes the hard-coded limit, and multiplies by only 3.</li>
<li>Change the output behavior - by default, the per-thread status messages will no longer be output. Per-thread status messages are a large amount of output, and aren't usually necessary with good progress reporting. The old output can be re-enabled using the command line argument "-verbose 1"</li>
<li>Add the elapsed time to the overall progress report</li>
<li>Fix the overall progress reporting - get the active task progress again with the overall task progress.</li>
</ul>

<p>
<b>01/10/2017 v2017.01.10</b>
</p>
<ul>
<li>Allow CustomAminoAcid formulas to not specify a number if it is 1.</li>
<li>Updating UVPD scoring parameters</li>
</ul>

<p>
<b>12/12/2016 v2016.12.12</b>
</p>
Expand Down
33 changes: 32 additions & 1 deletion doc/MSGFPlus.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ <h1>MS-GF+</h1>
The combination of -t and -ti determins the precursor mass tolerance.
E.g. <span class="code-quote">"-t 20ppm -ti -1,2"</span> tests abs(exp-calc-n*1.00335Da)&lt;20ppm for n=-1, 0, 1, 2.
<span class="code-keyword">[-thread NumThreads]</span> (Number of concurrent threads to be executed, <span class="code-object">Default: Number of available cores</span>)
<span class="code-keyword">[-tasks NumTasks]</span> (Override the number of tasks to use on the threads, <span class="code-object">Default: (internally calculated based on inputs)</span>)
More tasks than threads will reduce the memory requirements of the search, but will be slower (how much depends on the inputs).
1&lt;=tasks&lt;=numThreads: will create one task per thread, which is the original behavior.
tasks=0: use default calculation - minimum of :(threads*3), and (numSpectra/250).
tasks&lt;0: multiply number of threads by abs(tasks) to determine number of tasks (i.e., -2 =&gt; "2 * numThreads" tasks).
One task per thread will use the most memory, but will usually finish the fastest.
2-3 tasks per thread will use comparably less memory, but may cause the search to take 1.5 to 2 times as long.
<span class="code-keyword">[-verbose 0/1]</span> (<span class="code-object">0: report total progress only (Default)</span>, 1: report total and per-thread progress/status)
<span class="code-keyword">[-tda 0/1]</span> (<span class="code-object">0: don't search decoy database (Default)</span>, 1: search decoy database)
<span class="code-keyword">[-m FragmentMethodID]</span> (<span class="code-object">0: As written in the spectrum or CID if no info (Default)</span>, 1: CID, 2: ETD, 3: HCD)
<span class="code-keyword">[-inst InstrumentID]</span> (<span class="code-object">0: Low-res LCQ/LTQ (Default)</span>, 1: High-res LTQ, 2: TOF, 3: Q-Exactive)
Expand Down Expand Up @@ -110,6 +118,29 @@ <h3>Parameters:</h3>
<li>Default value is the number of available logical cores (e.g. 8 for quad-core processor with hyper-threading support).</li>
</ul>
</li>
<li style="margin-bottom: 10px;">
<b>-tasks NumTasks</b> (Override the number of tasks to use on the threads, Default: (internally calculated based on inputs))
<ul>
<li>Manually set the number of tasks to create for the search.</li>
<li>More tasks than threads will reduce the memory requirements of the search, but will be slower (how much depends on the inputs).</li>
<li>If the spectrum file is particularly large, a larger number of tasks will decrease the possibility of out of memory errors.</li>
<li>If the fasta file being searched is larger than 10MB, more tasks will cause a noticeably longer search time.</li>
<li>1&lt;=tasks&lt;=numThreads: will create one task per thread, which is the original behavior.</li>
<li>tasks=0: use default calculation - minimum of :(threads*3), and (numSpectra/250).</li>
<li>tasks&lt;0: multiply number of threads by abs(tasks) to determine number of tasks (i.e., -2 =&gt; "2 * numThreads" tasks).</li>
<li>One task per thread will use the most memory, but will usually finish the fastest.</li>
<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>
</ul>
</li>
<li style="margin-bottom: 10px;">
<b>-verbose 0/1</b> (0: report total progress only (Default), 1: report total and per-thread progress/status)
<ul>
<li>Changes the verbosity of the output</li>
<li>If 0, only the overall progress is reported, creating the minimal useful output to console.</li>
<li>If 1, you see all of the output of 0, but with additional console output from each thread and task.</li>
<li>1 will produce console output that matches the console output prior to this version.</li>
</ul>
</li>
<li>
<b>-tda 0/1</b> (0: don't search decoy database (default), 1: search decoy database to compute FDR)
<ul>
Expand Down Expand Up @@ -181,7 +212,7 @@ <h3>Parameters:</h3>
</li>
<li>By default, -ntt 2 will be used. Using -ntt 1 (or 0) will make the search significantly slower.</li>
</ul>
</li>
</li>
</ul>
<p class="note">The meaning and the default value have changed as of version 8442 (Sept. 2012).</p>

Expand Down
4 changes: 2 additions & 2 deletions src/main/java/edu/ucsd/msjava/ui/MSGFPlus.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@


public class MSGFPlus {
public static final String VERSION = "Release (v2017.01.13)";
public static final String RELEASE_DATE = "13 Jan 2017";
public static final String VERSION = "Release (v2017.01.27)";
public static final String RELEASE_DATE = "27 Jan 2017";

public static final String DECOY_DB_EXTENSION = ".revCat.fasta";
public static final String DECOY_PROTEIN_PREFIX = "XXX";
Expand Down

0 comments on commit 00643b0

Please sign in to comment.