forked from crux-toolkit/crux-toolkit.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
q-ranker.html
160 lines (159 loc) · 13.2 KB
/
q-ranker.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html>
<html>
<head>
<title>q-ranker</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" type="text/css" href="../styles.css">
<script type="text/javascript"
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
<script type="text/javascript">
MathJax.Hub.Config({jax: ['input/TeX','output/HTML-CSS'], displayAlign: 'left'});
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-26136956-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
<script type="text/javascript">
// Main Menu
$( document ).ready(function() {
var pull = $('.btn');
menu = $('nav ul');
menuHeight = menu.height();
$(pull).on('click', function(e) {
e.preventDefault();
menu.slideToggle();
});
$(window).resize(function(){
var w = $(window).width();
if(w > 320 && menu.is(':hidden')) {
menu.removeAttr('style');
}
});
});
</script>
</head>
<body>
<div class="page-wrap">
<nav>
<div class="btn">
</div>
<img src="../images/crux-logo.png" id="logo"></a>
<ul id="navitems">
<li><a href="../index.html">Home</a></li>
<li><a href="../download.html">Download</a></li>
<li><a href="../fileformats.html">File Formats</a></li>
<li><a href="http://groups.google.com/group/crux-users">Contact</a></li> <!--Link to google support board-->
</ul>
</nav>
<div id="content" class="autogenerated">
<!-- START CONTENT -->
<h1>q-ranker</h1>
<h2>Usage:</h2>
<p><code>crux q-ranker [options] <fragmentation spectra> <search results></code></p>
<h2>Description:</h2>
<p>Q-ranker dynamically learns to separate target from decoy PSMs. The algorithm is described in this article:</p><blockquote>Marina Spivak, Jason Weston, Leon Bottou and William Stafford Noble. <a href="http://noble.gs.washington.edu/papers/spivak2009improvements.html">"Direct <em>q</em> value optimization methods for peptide identification from shotgun proteomics data sets."</a> <em>Journal of Proteome Research</em>. 8(7):3737-3745, 2009.</blockquote><p>For more on q-values and posterior error probabilities (PEP), see the documentation for <a href="assign-confidence.html">assign-confidence</a>.</p>
<h2>Input:</h2>
<ul>
<li><code>fragmentation spectra</code> – The fragmentation spectra must be provided in <a href="../file-formats/ms2-format.html">MS2</a>, mzXML, or MGF format.</li>
<li><code>search results</code> – Search results in the <a href="../file-formats/txt-format.html">tab-delimited text format</a> produced by Crux or in <a href="../file-formats/sqt-format.html">SQT format</a>. Like the spectra, the search results can be provided as a single file, a list of files or a directory of files. Note, however, that the input mode for spectra and for search results must be the same; i.e., if you provide a list of files for the spectra, then you must also provide a list of files containing your search results. When the MS2 files and tab-delimited text files are provided via a file listing, it is assumed that the order of the MS2 files matches the order of the tab-delimited files. Alternatively, when the MS2 files and tab-delimited files are provided via directories, the program will search for pairs of files with the same root name but different extensions (".ms2" and ".txt").</li>
</ul>
<h2>Output:</h2>
<p>The program writes files to the folder <code>crux-output</code> by default. The name of the output folder can be set by the user using the <code>--output-dir</code> option. The following files will be created:
<ul>
<li><code>qranker.target.pep.xml</code> – An xml file containing ranked list of target peptide-spectrum matches. Thefollowing entries are included: scan, charge, psm_id, q-value, score, precursor_mass, peptide, filename.</li>
<li><code>qranker.decoy.pep.xml</code> – An xml file containing ranked list of decoy peptide-spectrum matches.</li>
<li><code>qranker.target.psm.txt</code> – a <a href="../file-formats/txt-format.html">tab-delimited text format</a> containing a ranked list of target peptide-spectrum matches with the associated Q-ranker scores and q-values.</li>
<li><code>qranker.decoy.psm.txt</code> – a <a href="../file-formats/txt-format.html">tab-delimited text format</a> containing a ranked list of decoy peptide-spectrum matches with the associated Q-ranker scores and q-values.</li>
<li><code>qranker.log.txt</code> – a file where the program reports its progress.</li>
<li><code>qranker.params.txt</code> – a file with the values of all the options given to the current run.</li>
</ul>
<h2>Options:</h2>
<ul style="list-style-type: none;">
<li class="nobullet">
<h3>q-ranker options</h3>
<ul>
<li class="nobullet"><code>--separate-searches <string></code> – If the target and decoy searches were run separately, rather than using a concatenated database, then the program will assume that the database search results provided as a required argument are from the target database search. This option then allows the user to specify the location of the decoy search results. Like the required arguments, these search results can be provided as a single file, a list of files or a directory. However, the choice (file, list or directory) must be consistent for the MS2 files and the target and decoy tab-delimited files. Also, if the MS2 and tab-delimited files are provided in directories, then Q-ranker will use the MS2 filename (foo.ms2) to identify corresponding target and decoy tab-delimited files with names like foo*.target.txt and foo*.decoy.txt. This naming convention allows the target and decoy txt files to reside in the same directory. Default = <code><empty></code>.</li>
<li class="nobullet"><code>--skip-cleanup T|F</code> – Analysis begins with a pre-processsing step that creates a set of lookup tables which are then used during training. Normally, these lookup tables are deleted at the end of the analysis, but setting this option to T prevents the deletion of these tables. Subsequently, analyses can be repeated more efficiently by specifying the --re-run option. Default = <code>false</code>.</li>
<li class="nobullet"><code>--re-run <string></code> – Re-run a previous analysis using a previously computed set of lookup tables. For this option to work, the --skip-cleanup option must have been set to true when the program was run the first time. Default = <code><empty></code>.</li>
<li class="nobullet"><code>--use-spec-features T|F</code> – Use an enriched feature set, including separate features for each ion type. Default = <code>true</code>.</li>
</ul>
</li>
<li class="nobullet">
<h3>Enzymatic digestion</h3>
<ul>
<li class="nobullet"><code>--enzyme no-enzyme|trypsin|trypsin/p|chymotrypsin|elastase|clostripain|cyanogen-bromide|iodosobenzoate|proline-endopeptidase|staph-protease|asp-n|lys-c|lys-n|arg-c|glu-c|pepsin-a|elastase-trypsin-chymotrypsin|custom-enzyme</code> – Specify the enzyme used to digest the proteins in silico. Available enzymes (with the corresponding digestion rules indicated in parentheses) include no-enzyme ([X]|[X]), trypsin ([RK]|{P}), trypsin/p ([RK]|[]), chymotrypsin ([FWYL]|{P}), elastase ([ALIV]|{P}), clostripain ([R]|[]), cyanogen-bromide ([M]|[]), iodosobenzoate ([W]|[]), proline-endopeptidase ([P]|[]), staph-protease ([E]|[]), asp-n ([]|[D]), lys-c ([K]|{P}), lys-n ([]|[K]), arg-c ([R]|{P}), glu-c ([DE]|{P}), pepsin-a ([FL]|{P}), elastase-trypsin-chymotrypsin ([ALIVKRWFY]|{P}). Specifying --enzyme no-enzyme yields a non-enzymatic digest. <strong>Warning:</strong> the resulting index may be quite large. Default = <code>trypsin</code>.</li>
</ul>
</li>
<li class="nobullet">
<h3>Input and output</h3>
<ul>
<li class="nobullet"><code>--decoy-prefix <string></code> – Specifies the prefix of the protein names that indicate a decoy. Default = <code>decoy_</code>.</li>
<li class="nobullet"><code>--fileroot <string></code> – The fileroot string will be added as a prefix to all output file names. Default = <code><empty></code>.</li>
<li class="nobullet"><code>--output-dir <string></code> – The name of the directory where output files will be created. Default = <code>crux-output</code>.</li>
<li class="nobullet"><code>--overwrite T|F</code> – Replace existing files if true or fail when trying to overwrite a file if false. Default = <code>false</code>.</li>
<li class="nobullet"><code>--pepxml-output T|F</code> – Output a pepXML results file to the output directory. Default = <code>false</code>.</li>
<li class="nobullet"><code>--txt-output T|F</code> – Output a tab-delimited results file to the output directory. Default = <code>true</code>.</li>
<li class="nobullet"><code>--parameter-file <string></code> – A file containing parameters. See the <a href="../file-formats/parameter-file.html">parameter documentation</a> page for details. Default = <code><empty></code>.</li>
<li class="nobullet"><code>--verbosity <integer></code> – Specify the verbosity of the current processes. Each level prints the following messages, including all those at lower verbosity levels: 0-fatal errors, 10-non-fatal errors, 20-warnings, 30-information on the progress of execution, 40-more progress information, 50-debug info, 60-detailed debug info. Default = <code>30</code>.</li>
<li class="nobullet"><code>--list-of-files T|F</code> – Specify that the search results are provided as lists of files, rather than as individual files. Default = <code>false</code>.</li>
<li class="nobullet"><code>--feature-file-out T|F</code> – Output the computed features in <a href="../file-formats/features.html">tab-delimited text format</a>. Default = <code>false</code>.</li>
<li class="nobullet"><code>--spectrum-parser pwiz|mstoolkit</code> – Specify the parser to use for reading in MS/MS spectra. The default, ProteoWizard parser can read the MS/MS file formats listed <a href="http://proteowizard.sourceforge.net/formats.shtml">here</a>. The alternative is <a href="../mstoolkit.html">MSToolkit parser</a>. If the ProteoWizard parser fails to read your files properly, you may want to try the MSToolkit parser instead. Default = <code>pwiz</code>.</li>
</ul>
</li>
</ul>
<!-- END CONTENT -->
</div>
</div>
<footer class="site-footer">
<div id="centerfooter">
<div class="footerimportantlinks">
<img src="../images/linkicon.png" style="width:16px; height:16px"><h3>Important links</h3>
<ul>
<li><a href="../faq.html">Crux <strong>FAQ</strong></a></li>
<li><a href="../glossary.html">Glossary of terminology</a></li>
<li><a href="http://scholar.google.com/citations?hl=en&user=Rw9S1HIAAAAJ">Google Scholar profile</a></li>
<li><a href="https://sourceforge.net/projects/cruxtoolkit/">SourceForge Issue's list</a></li>
<li><a href="../release-notes.html">Release Notes</a></li>
<li><a href="https://mailman1.u.washington.edu/mailman/listinfo/crux-users" title="Receive announcements of new versions">Join the mailing list</a></li>
<li><a href="http://www.apache.org/licenses/LICENSE-2.0">Apache license</a></li>
<li><a href="http://groups.google.com/group/crux-users">Support Board</a></li>
</ul>
</div>
<div class="footerimportantlinks tutoriallinks">
<img src="../images/tutorialicon.png" style="height:16px"><h3>Tutorials</h3>
<ul>
<li><a href="../tutorials/install.html">Installation</a></li>
<li><a href="../tutorials/gettingstarted.html">Getting started with Crux</a></li>
<li><a href="../tutorials/search.html">Running a simple search using Tide and Percolator</a></li>
<li><a href="../tutorials/customizedsearch.html">Customization and search options</a></li>
<li><a href="../tutorials/spectralcounts.html">Using spectral-counts</a></li>
</ul>
</div>
<div id="footertext">
<p>
The original version of Crux was written by Chris Park and Aaron Klammer
under the supervision
of <a href="http://www.gs.washington.edu/faculty/maccoss.htm">Prof. Michael
MacCoss</a>
and <a href="http://noble.gs.washington.edu/~noble">Prof. William
Stafford Noble</a> in the Department of Genome Sciences at the
University of Washington, Seattle. Website by <a href="http://www.yuvalboss.com/">Yuval Boss</a>
<br />The complete list of contributors
can be found <a href="../contributors.html">here</a>.
<br />
<br />
Maintenance and development of Crux is funded by the <a href="https://www.nih.gov/">National Institutes of Health</a> awards R01 GM096306 and P41 GM103533.
</p>
</div>
</div>
</footer>
</body>
</html>