annotate FidoAdapter.xml @ 4:60a33af52042 draft default tip

Uploaded
author galaxyp
date Wed, 13 May 2015 21:19:44 -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="FidoAdapter" name="FidoAdapter" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Runs the protein inference engine Fido.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">FidoAdapter</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>FidoAdapter
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
11 -fidocp_executable FidoChooseParameters
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
12 -fido_executable Fido
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
13
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
14 #if $param_in:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
15 -in $param_in
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #if $param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 -out $param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #if $param_prob_param:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 -prob_param "$param_prob_param"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #if $param_separate_runs:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 -separate_runs
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #if $param_no_cleanup:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 -no_cleanup
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 #if $param_all_PSMs:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 -all_PSMs
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 #if $param_group_level:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 -group_level
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 #if $param_log2_states:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 -log2_states $param_log2_states
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #if $param_prob_protein:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 -prob:protein $param_prob_protein
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #if $param_prob_peptide:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 -prob:peptide $param_prob_peptide
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if $param_prob_spurious:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 -prob:spurious $param_prob_spurious
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 #if $adv_opts.param_keep_zero_group:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 -keep_zero_group
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 #if $adv_opts.param_accuracy:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 -accuracy
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 #if " " in str($adv_opts.param_accuracy):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 "$adv_opts.param_accuracy"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 $adv_opts.param_accuracy
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 #if $adv_opts.param_log2_states_precalc:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 -log2_states_precalc $adv_opts.param_log2_states_precalc
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 <param name="param_in" type="data" format="idxml" optional="False" label="Input: identification results" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 <param name="param_prob_param" type="text" size="30" value="Posterior Probability_score" label="Read the peptide probability from this user parameter ('UserParam') in the input file, instead of from the 'score' field, if available. (Use" help="(-prob_param) e.g. for search results that were processed with the TOPP tools IDPosteriorErrorProbability followed by FalseDiscoveryRate.)">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 <param name="param_separate_runs" type="boolean" truevalue="-separate_runs" falsevalue="" checked="false" optional="True" label="Process multiple protein identification runs in the input separately, don't merge them" help="(-separate_runs) Merging results in loss of descriptive information of the single protein identification runs"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <param name="param_no_cleanup" type="boolean" truevalue="-no_cleanup" falsevalue="" checked="false" optional="True" label="Omit clean-up of peptide sequences (removal of non-letter characters, replacement of I with L)" help="(-no_cleanup) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <param name="param_all_PSMs" type="boolean" truevalue="-all_PSMs" falsevalue="" checked="false" optional="True" label="Consider all PSMs of each peptide, instead of only the best one" help="(-all_PSMs) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <param name="param_group_level" type="boolean" truevalue="-group_level" falsevalue="" checked="false" optional="True" label="Perform inference on protein group level (instead of individual protein level)" help="(-group_level) This will lead to higher probabilities for (bigger) protein groups"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 <param name="param_log2_states" type="integer" min="0" optional="True" value="0" label="Binary logarithm of the max" help="(-log2_states) number of connected states in a subgraph. For a value N, subgraphs that are bigger than 2^N will be split up, sacrificing accuracy for runtime. '0' uses the default (18)"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 <param name="param_prob_protein" type="float" min="0.0" optional="True" value="0.0" label="Protein prior probability ('gamma' parameter)" help="(-protein) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 <param name="param_prob_peptide" type="float" min="0.0" optional="True" value="0.0" label="Peptide emission probability ('alpha' parameter)" help="(-peptide) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 <param name="param_prob_spurious" type="float" min="0.0" optional="True" value="0.0" label="Spurious peptide identification probability ('beta' parameter)" help="(-spurious) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 <param name="param_keep_zero_group" type="boolean" truevalue="-keep_zero_group" falsevalue="" checked="false" optional="True" label="Keep the group of proteins with estimated probability of zero, which is otherwise removed (it may be very large)" help="(-keep_zero_group) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 <param name="param_accuracy" type="select" optional="True" label="Accuracy level of start parameters" help="(-accuracy) There is a trade-off between accuracy and runtime. Empty uses the default ('best')">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 <option value=""></option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 <option value="best">best</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 <option value="relaxed">relaxed</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 <option value="sloppy">sloppy</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 <param name="param_log2_states_precalc" type="integer" min="0" optional="True" value="0" label="Like 'log2_states', but allows to set a separate limit for the precalculation" help="(-log2_states_precalc) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 <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
96 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 <data name="param_out" format="idxml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 Runs the protein inference engine Fido.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_FidoAdapter.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 </tool>