annotate IDFileConverter.xml @ 3:ec62782f6c68 draft

Uploaded
author bgruening
date Mon, 13 Oct 2014 10:18:22 -0400
parents 3d84209d3178
children 6ead64a594bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
2 <tool id="IDFileConverter" name="IDFileConverter" version="1.12.0">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
3 <description>Converts identification engine file formats.</description>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
4 <macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">IDFileConverter</token>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
7 </macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
8 <expand macro="stdio"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
9 <expand macro="requirements"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
10 <command>IDFileConverter
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
11
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
12 -in ${param_in}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
13 -out ${param_out}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
14 -out_type ${param_out_type}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
15 -mz_file ${param_mz_file}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
16 -mz_name ${param_mz_name}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
17 ${param_use_precursor_data}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
18 ${param_peptideprophet_analyzed}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
19 -threads \${GALAXY_SLOTS:-24}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
20 #if $adv_opts.adv_opts_selector=='advanced':
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
21 ${adv_opts.param_ignore_proteins_per_peptide}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
22 -scan_regex ${adv_opts.param_scan_regex}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
23 #end if
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
24 </command>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
25 <inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
26 <param name="param_in" type="data" format="pepXML,idXML" optional="False" label="Input file or directory containing the output of the search engine.#br#Sequest: Directory containing the .out files#br#pepXML: Single pepXML file.#br#protXML: Single protXML file.#br#mascotXML: Single Mascot XML file.#br#omssaXML: Single OMSSA XML file.#br#XTandem: Single XML file.#br#idXML: Single idXML file.#br#" help="(-in)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
27 <param name="param_out_type" type="select" optional="True" label="output file type -- default: determined from file extension or content#br#" help="(-out_type)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
28 <option value="idXML">idXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
29 <option value="mzid">mzid</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
30 <option value="pepXML">pepXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
31 <option value="FASTA">FASTA</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
32 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
33 <param name="param_mz_file" type="data" format="mzML,mzXML" optional="True" label="[Sequest, pepXML, mascotXML, XTandem only] Retention times will be looked up in this file" help="(-mz_file)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
34 <param name="param_mz_name" type="text" size="20" label="[pepXML only] Experiment filename/path (extension will be removed) to match in the pepXML file ('base_name' attribute). Only necessary if different from 'mz_file'." help="(-mz_name)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
35 <param name="param_use_precursor_data" type="boolean" truevalue="-use_precursor_data true" falsevalue="-use_precursor_data false" checked="false" optional="True" label="[pepXML only] Use precursor RTs (and m/z values) from 'mz_file' for the generated peptide identifications, instead of the RTs of MS2 spectra." help="(-use_precursor_data)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
36 <param name="param_peptideprophet_analyzed" type="boolean" truevalue="-peptideprophet_analyzed true" falsevalue="-peptideprophet_analyzed false" checked="false" optional="True" label="[pepXML output only] Write output in the format of a PeptideProphet analysis result. By default a 'raw' pepXML is produced that contains only search engine results." help="(-peptideprophet_analyzed)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
37 <expand macro="advanced_options">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
38 <param name="param_ignore_proteins_per_peptide" type="boolean" truevalue="-ignore_proteins_per_peptide true" falsevalue="-ignore_proteins_per_peptide false" checked="false" optional="True" label="[Sequest only] Workaround to deal with .out files that contain e.g. &quot;+1&quot; in references column,#br#but do not list extra references in subsequent lines (try -debug 3 or 4)" help="(-ignore_proteins_per_peptide)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
39 <param name="param_scan_regex" type="text" size="20" label="[mascotXML only] Regular expression used to extract the scan number or retention time. See documentation for details." help="(-scan_regex)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
40 </expand>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
41 </inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
42 <outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
43 <data name="param_out" label="Output file" format="pepXML">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
44 <change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
45 <when input="param_out_type" value="idXML" format="idXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
46 </change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
47 </data>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
48 </outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
49 <help>**What it does**
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
50
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
51 Converts identification engine file formats.
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
52
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
53
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
54 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_IDFileConverter.html
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
55
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
56 @REFERENCES@
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
57 </help>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
58 </tool>