annotate FileConverter.xml @ 0:3d84209d3178 draft

Uploaded
author bgruening
date Fri, 10 Oct 2014 18:20:03 -0400
parents
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="FileConverter" name="FileConverter" version="1.12.0">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
3 <description>Converts between different MS file formats.</description>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
4 <macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">FileConverter</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>FileConverter
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
11
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
12 -in ${param_in}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
13 -in_type ${param_in_type}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
14 -UID_postprocessing ${param_UID_postprocessing}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
15 -out ${param_out}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
16 -out_type ${param_out_type}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
17 ${param_write_mzML_index}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
18 -threads \${GALAXY_SLOTS:-24}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
19 #if $adv_opts.adv_opts_selector=='advanced':
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
20 ${adv_opts.param_TIC_DTA2D}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
21 ${adv_opts.param_MGF_compact}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
22 ${adv_opts.param_process_lowmemory}
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="mzXML,mzML,mgf,featureXML,consensusXML" optional="False" label="Input file to convert." help="(-in)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
27 <param name="param_in_type" type="select" optional="True" label="Input file type -- default: determined from file extension or content#br#" help="(-in_type)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
28 <option value="mzData">mzData</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
29 <option value="mzXML">mzXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
30 <option value="mzML">mzML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
31 <option value="dta">dta</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
32 <option value="dta2d">dta2d</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
33 <option value="mgf">mgf</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
34 <option value="featureXML">featureXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
35 <option value="consensusXML">consensusXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
36 <option value="ms2">ms2</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
37 <option value="fid">fid</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
38 <option value="tsv">tsv</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
39 <option value="peplist">peplist</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
40 <option value="kroenik">kroenik</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
41 <option value="edta">edta</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
42 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
43 <param name="param_UID_postprocessing" type="select" optional="True" value="ensure" label="unique ID post-processing for output data.#br#'none' keeps current IDs even if invalid.#br#'ensure' keeps current IDs but reassigns invalid ones.#br#'reassign' assigns new unique IDs." help="(-UID_postprocessing)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
44 <option value="none">none</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
45 <option value="ensure">ensure</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
46 <option value="reassign">reassign</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
47 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
48 <param name="param_out_type" type="select" optional="True" label="Output file type -- default: determined from file extension or content#br#Note: that not all conversion paths work or make sense." help="(-out_type)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
49 <option value="mzData">mzData</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
50 <option value="mzXML">mzXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
51 <option value="mzML">mzML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
52 <option value="dta2d">dta2d</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
53 <option value="mgf">mgf</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
54 <option value="featureXML">featureXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
55 <option value="consensusXML">consensusXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
56 <option value="edta">edta</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
57 <option value="csv">csv</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
58 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
59 <param name="param_write_mzML_index" type="boolean" truevalue="-write_mzML_index true" falsevalue="-write_mzML_index false" checked="false" optional="True" label="Whether to add an index to the file when writing mzML files" help="(-write_mzML_index)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
60 <expand macro="advanced_options">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
61 <param name="param_TIC_DTA2D" type="boolean" truevalue="-TIC_DTA2D true" falsevalue="-TIC_DTA2D false" checked="false" optional="True" label="Export the TIC instead of the entire experiment in mzML/mzData/mzXML -&gt; DTA2D conversions." help="(-TIC_DTA2D)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
62 <param name="param_MGF_compact" type="boolean" truevalue="-MGF_compact true" falsevalue="-MGF_compact false" checked="false" optional="True" label="Use a more compact format when writing MGF (no zero-intensity peaks, limited number of decimal places)" help="(-MGF_compact)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
63 <param name="param_process_lowmemory" type="boolean" truevalue="-process_lowmemory true" falsevalue="-process_lowmemory false" checked="false" optional="True" label="Whether to process the file on the fly without loading the whole file into memory first (only for conversions of mzXML/mzML to mzML).#br#Note: this flag will prevent conversion from spectra to chromatograms." help="(-process_lowmemory)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
64 </expand>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
65 </inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
66 <outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
67 <data name="param_out" label="Output file" format="tabular">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
68 <change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
69 <when input="param_out_type" value="mzXML" format="mzXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
70 <when input="param_out_type" value="mzML" format="mzML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
71 <when input="param_out_type" value="mgf" format="mgf"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
72 <when input="param_out_type" value="featureXML" format="featureXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
73 <when input="param_out_type" value="consensusXML" format="consensusXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
74 </change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
75 </data>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
76 </outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
77 <help>**What it does**
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
78
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
79 Converts between different MS file formats.
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
80
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
81
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
82 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_FileConverter.html
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
83
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
84 @REFERENCES@
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
85 </help>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
86 </tool>