annotate OpenSwathDecoyGenerator.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="OpenSwathDecoyGenerator" name="OpenSwathDecoyGenerator" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Generates decoys according to different models for a specific TraML</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">OpenSwathDecoyGenerator</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>OpenSwathDecoyGenerator
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_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 -out $param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 #if $param_method:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 -method "$param_method"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #if $param_decoy_tag:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 -decoy_tag "$param_decoy_tag"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #if $param_theoretical:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 -theoretical
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 #if $param_mz_threshold:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 -mz_threshold $param_mz_threshold
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #if $param_exclude_similar:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 -exclude_similar
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #if $param_similarity_threshold:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 -similarity_threshold $param_similarity_threshold
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 #if $param_append:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 -append
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #if $param_remove_CNterm_mods:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 -remove_CNterm_mods
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #if $param_remove_unannotated:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 -remove_unannotated
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if $param_enable_losses:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 -enable_losses
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 #if $param_identity_threshold:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 -identity_threshold $param_identity_threshold
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 #if $param_max_attempts:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 -max_attempts $param_max_attempts
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 #if $param_mz_shift:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 -mz_shift $param_mz_shift
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #if $param_precursor_mass_shift:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 -precursor_mass_shift $param_precursor_mass_shift
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 <param name="param_in" type="data" format="traml" optional="False" label="input file ('traML')" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 <param name="param_method" type="text" size="30" value="shuffle" label="decoy generation method ('shuffle','pseudo-reverse','reverse','shift')" help="(-method) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 <param name="param_decoy_tag" type="text" size="30" value="DECOY_" label="decoy tag" help="(-decoy_tag) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 <param name="param_theoretical" type="boolean" truevalue="-theoretical" falsevalue="" checked="false" optional="True" label="set this flag if only annotated transitions should be used and be corrected to the theoretical mz" help="(-theoretical) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <param name="param_mz_threshold" type="float" value="0.05" label="MZ threshold in Thomson for fragment ion annotation" help="(-mz_threshold) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 <param name="param_exclude_similar" type="boolean" truevalue="-exclude_similar" falsevalue="" checked="false" optional="True" label="set this flag if decoy assays with similarity of the peptide sequence to the target assays higher than the identity_threshold should be excluded" help="(-exclude_similar) If similarity_threshold is over 0, decoy assays with an absolute difference of the decoy and target product mz smaller than similarity_threshold are further excluded"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 <param name="param_similarity_threshold" type="float" value="-1.0" label="Similarity threshold for absolute difference of the product mz of target and decoy assays for exclusion in Dalton" help="(-similarity_threshold) Suggested value: 0.05"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 <param name="param_append" type="boolean" truevalue="-append" falsevalue="" checked="false" optional="True" label="set this flag if non-decoy TraML should be appended to the output" help="(-append) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 <param name="param_remove_CNterm_mods" type="boolean" truevalue="-remove_CNterm_mods" falsevalue="" checked="false" optional="True" label="set this flag to remove decoy peptides with C/N terminal modifications (may be necessary depending on the decoy generation method)" help="(-remove_CNterm_mods) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 <param name="param_remove_unannotated" type="boolean" truevalue="-remove_unannotated" falsevalue="" checked="false" optional="True" label="set this flag if target assays with unannotated ions should be ignored from decoy generation" help="(-remove_unannotated) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 <param name="param_enable_losses" type="boolean" truevalue="-enable_losses" falsevalue="" checked="false" optional="True" label="set this flag if fragment ions should also be annotated with neutral losses" help="(-enable_losses) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 <param name="param_identity_threshold" type="float" value="0.7" label="shuffle: identity threshold for the shuffle algorithm" help="(-identity_threshold) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 <param name="param_max_attempts" type="integer" value="10" label="shuffle: maximum attempts to lower the sequence identity between target and decoy for the shuffle algorithm" help="(-max_attempts) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 <param name="param_mz_shift" type="float" value="20.0" label="shift: MZ shift in Thomson for shift decoy method" help="(-mz_shift) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 <param name="param_precursor_mass_shift" type="float" value="0.0" label="Mass shift to apply to the precursor ion" help="(-precursor_mass_shift) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 <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
99 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 <data name="param_out" format="traml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 Generates decoys according to different models for a specific TraML
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_OpenSwathDecoyGenerator.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
111 </tool>