annotate ProteinQuantifier.xml @ 1:e37e8ba1b4b7 draft

Uploaded
author bgruening
date Thu, 16 Apr 2015 09:01:52 -0400
parents 3070d71e0e5c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
2 <tool id="ProteinQuantifier" name="ProteinQuantifier" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Compute peptide and protein abundances</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">ProteinQuantifier</token>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
7 </macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
8 <expand macro="stdio"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
9 <expand macro="requirements"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
10 <command>ProteinQuantifier
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
11
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
12 #if $param_in:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
13 -in $param_in
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
14 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
15 #if $param_protein_groups:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 -protein_groups $param_protein_groups
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 #if $param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 -out $param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #if $param_peptide_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 -peptide_out $param_peptide_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #if $param_top:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 -top $param_top
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 #if $param_average:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 -average
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 #if " " in str($param_average):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 "$param_average"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 $param_average
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 #if $param_include_all:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 -include_all
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #if $param_filter_charge:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 -filter_charge
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #if $param_ratios:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 -ratios
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #if $param_ratiosSILAC:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 -ratiosSILAC
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 #if $param_consensus_normalize:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 -consensus:normalize
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 #if $param_consensus_fix_peptides:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 -consensus:fix_peptides
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 #if $param_format_separator:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 -format:separator "$param_format_separator"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #if $param_format_quoting:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 -format:quoting
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #if " " in str($param_format_quoting):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 "$param_format_quoting"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 $param_format_quoting
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 #if $param_format_replacement:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 -format:replacement "$param_format_replacement"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 <param name="param_in" type="data" format="featurexml,consensusxml,idxml" optional="False" label="Input file" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 <param name="param_protein_groups" type="data" format="idxml" optional="True" label="Protein inference results for the identification runs that were used to annotate the input (" help="(-protein_groups) e.g. from ProteinProphet via IDFileConverter or Fido via FidoAdapter). &lt;br&gt;Information about indistinguishable proteins will be used for protein quantification"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 <param name="param_top" type="integer" min="0" optional="True" value="3" label="Calculate protein abundance from this number of proteotypic peptides (most abundant first; '0' for all)" help="(-top) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 <param name="param_average" type="select" optional="True" value="median" label="Averaging method used to compute protein abundances from peptide abundances" help="(-average) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <option value="median">median</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <option value="mean">mean</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <option value="weighted_mean">weighted_mean</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 <option value="sum">sum</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 <param name="param_include_all" type="boolean" truevalue="-include_all" falsevalue="" checked="false" optional="True" label="Include results for proteins with fewer proteotypic peptides than indicated by 'top' (no effect if 'top' is 0 or 1)" help="(-include_all) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 <param name="param_filter_charge" type="boolean" truevalue="-filter_charge" falsevalue="" checked="false" optional="True" label="Distinguish between charge states of a peptide" help="(-filter_charge) For peptides, abundances will be reported separately for each charge; &lt;br&gt;for proteins, abundances will be computed based only on the most prevalent charge of each peptide. &lt;br&gt;By default, abundances are summed over all charge states"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <param name="param_ratios" type="boolean" truevalue="-ratios" falsevalue="" checked="false" optional="True" label="Add the log2 ratios of the abundance values to the output" help="(-ratios) Format: log_2(x_0/x_0) &lt;sep&gt; log_2(x_1/x_0) &lt;sep&gt; log_2(x_2/x_0) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 <param name="param_ratiosSILAC" type="boolean" truevalue="-ratiosSILAC" falsevalue="" checked="false" optional="True" label="Add the log2 ratios for a triple SILAC experiment to the output" help="(-ratiosSILAC) Only applicable to consensus maps of exactly three sub-maps. Format: log_2(heavy/light) &lt;sep&gt; log_2(heavy/middle) &lt;sep&gt; log_2(middle/light)"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 <param name="param_consensus_normalize" type="boolean" truevalue="-consensus:normalize" falsevalue="" checked="false" optional="True" label="Scale peptide abundances so that medians of all samples are equal" help="(-normalize) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 <param name="param_consensus_fix_peptides" type="boolean" truevalue="-consensus:fix_peptides" falsevalue="" checked="false" optional="True" label="Use the same peptides for protein quantification across all samples" help="(-fix_peptides) &lt;br&gt;With 'top 0', all peptides that occur in every sample are considered. &lt;br&gt;Otherwise ('top N'), the N peptides that occur in the most samples (independently of each other) are selected, &lt;br&gt;breaking ties by total abundance (there is no guarantee that the best co-ocurring peptides are chosen!)"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 <param name="param_format_separator" type="text" size="30" label="Character(s) used to separate fields; by default, the 'tab' character is used" help="(-separator) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 <param name="param_format_quoting" type="select" optional="True" value="double" label="Method for quoting of strings: 'none' for no quoting, 'double' for quoting with doubling of embedded quotes, &lt;br&gt;'escape' for quoting with backslash-escaping of embedded quotes" help="(-quoting) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 <option value="none">none</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 <option value="double">double</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 <option value="escape">escape</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 <param name="param_format_replacement" type="text" size="30" value="_" label="If 'quoting' is 'none', used to replace occurrences of the separator in strings before writing" help="(-replacement) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
111 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
112 <param name="param_force" type="boolean" truevalue="-force" falsevalue="" checked="false" optional="True" label="Overwrite tool specific checks" help="(-force) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
113 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
114 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
115 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
116 <data name="param_out" format="tabular"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
117 <data name="param_peptide_out" format="tabular"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
118 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
119 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
120
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
121 Compute peptide and protein abundances
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
122
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
123
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
124 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_ProteinQuantifier.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
125 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
126 </tool>