annotate PeptideIndexer.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="PeptideIndexer" name="PeptideIndexer" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Refreshes the protein references for all peptide hits.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">PeptideIndexer</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>PeptideIndexer
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_fasta:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 -fasta $param_fasta
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_decoy_string:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 -decoy_string "$param_decoy_string"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #if $param_missing_decoy_action:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 -missing_decoy_action
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #if " " in str($param_missing_decoy_action):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 "$param_missing_decoy_action"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 $param_missing_decoy_action
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 #if $param_prefix:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 -prefix
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 #if $param_annotate_proteins:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 -annotate_proteins
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #if $param_write_protein_sequence:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 -write_protein_sequence
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #if $param_keep_unreferenced_proteins:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 -keep_unreferenced_proteins
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #if $param_allow_unmatched:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 -allow_unmatched
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #if $param_full_tolerant_search:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 -full_tolerant_search
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #if $param_aaa_max:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 -aaa_max $param_aaa_max
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #if $param_IL_equivalent:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 -IL_equivalent
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #if $param_enzyme_name:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 -enzyme:name
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #if " " in str($param_enzyme_name):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 "$param_enzyme_name"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 $param_enzyme_name
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_enzyme_specificity:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 -enzyme:specificity
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 #if " " in str($param_enzyme_specificity):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 "$param_enzyme_specificity"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 $param_enzyme_specificity
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 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <param name="param_in" type="data" format="idxml" optional="False" label="Input idXML file containing the identifications" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <param name="param_fasta" type="data" format="fasta" optional="False" label="Input sequence database in FASTA format" help="(-fasta) Non-existing relative filenames are looked up via 'OpenMS.ini:id_db_dir'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 <param name="param_decoy_string" type="text" size="30" value="_rev" label="String that was appended (or prefixed - see 'prefix' flag below) to the accessions in the protein database to indicate decoy proteins" help="(-decoy_string) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 <param name="param_missing_decoy_action" type="select" optional="True" value="error" label="Action to take if NO peptide was assigned to a decoy protein (which indicates wrong database or decoy string): 'error' (exit with error, no output), 'warn' (exit with success, warning message)" help="(-missing_decoy_action) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 <option value="error">error</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 <option value="warn">warn</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 <param name="param_prefix" type="boolean" truevalue="-prefix" falsevalue="" checked="false" optional="True" label="If set, protein accessions in the database contain 'decoy_string' as prefix" help="(-prefix) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 <param name="param_annotate_proteins" type="boolean" truevalue="-annotate_proteins" falsevalue="" checked="false" optional="True" label="If set, add target/decoy information to proteins (as well as peptides)" help="(-annotate_proteins) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 <param name="param_write_protein_sequence" type="boolean" truevalue="-write_protein_sequence" falsevalue="" checked="false" optional="True" label="If set, the protein sequences are stored as well" help="(-write_protein_sequence) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 <param name="param_keep_unreferenced_proteins" type="boolean" truevalue="-keep_unreferenced_proteins" falsevalue="" checked="false" optional="True" label="If set, protein hits which are not referenced by any peptide are kept" help="(-keep_unreferenced_proteins) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 <param name="param_allow_unmatched" type="boolean" truevalue="-allow_unmatched" falsevalue="" checked="false" optional="True" label="If set, unmatched peptide sequences are allowed" help="(-allow_unmatched) By default (i.e. if this flag is not set) the program terminates with an error on unmatched peptides"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 <param name="param_full_tolerant_search" type="boolean" truevalue="-full_tolerant_search" falsevalue="" checked="false" optional="True" label="If set, all peptide sequences are matched using tolerant search" help="(-full_tolerant_search) Thus potentially more proteins (containing ambiguous amino acids) are associated. This is much slower!"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 <param name="param_aaa_max" type="integer" min="0" optional="True" value="4" label="Maximal number of ambiguous amino acids (AAA) allowed when matching to a protein database with AAA's" help="(-aaa_max) AAA's are 'B', 'Z' and 'X'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 <param name="param_IL_equivalent" type="boolean" truevalue="-IL_equivalent" falsevalue="" checked="false" optional="True" label="Treat the isobaric amino acids isoleucine ('I') and leucine ('L') as equivalent (indistinguishable)" help="(-IL_equivalent) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 <param name="param_enzyme_name" type="select" optional="True" value="Trypsin" label="Enzyme which determines valid cleavage sites -" help="(-name) e.g. trypsin cleaves after lysine (K) or arginine (R), but not before proline (P)">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 <option value="Trypsin">Trypsin</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104 <option value="none">none</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 <param name="param_enzyme_specificity" type="select" optional="True" value="full" label="Specificity of the enzyme" help="(-specificity) &lt;br&gt; 'full': both internal cleavage sites must match. &lt;br&gt; 'semi': one of two internal cleavage sites must match. &lt;br&gt; 'none': allow all peptide hits no matter their context. Therefore, the enzyme chosen does not play a role here">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107 <option value="full">full</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 <option value="semi">semi</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 <option value="none">none</option>
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="idxml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
117 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
118 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
119
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
120 Refreshes the protein references for all peptide hits.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
121
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
122
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
123 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_PeptideIndexer.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
124 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
125 </tool>