annotate FileConverter.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="FileConverter" name="FileConverter" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Converts between different MS file formats.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">FileConverter</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>FileConverter
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_UID_postprocessing:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 -UID_postprocessing
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #if " " in str($param_UID_postprocessing):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 "$param_UID_postprocessing"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 $param_UID_postprocessing
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #if $param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 -out $param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #if $param_out_type:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 -out_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #if " " in str($param_out_type):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 "$param_out_type"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 $param_out_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 #if $param_write_mzML_index:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 -write_mzML_index
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #if $adv_opts.param_TIC_DTA2D:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 -TIC_DTA2D
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #if $adv_opts.param_MGF_compact:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 -MGF_compact
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if $adv_opts.param_process_lowmemory:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 -process_lowmemory
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 <param name="param_in" type="data" format="mgf,mzml,mzxml,tabular,featurexml,consensusxml" optional="False" label="Input file to convert" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 <param name="param_UID_postprocessing" type="select" optional="True" value="ensure" label="unique ID post-processing for output data" help="(-UID_postprocessing) &lt;br&gt;'none' keeps current IDs even if invalid. &lt;br&gt;'ensure' keeps current IDs but reassigns invalid ones. &lt;br&gt;'reassign' assigns new unique IDs">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 <option value="none">none</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 <option value="ensure">ensure</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 <option value="reassign">reassign</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 <param name="param_out_type" type="select" optional="True" label="Output file type -- default: determined from file extension or content &lt;br&gt;Note: that not all conversion paths work or make sense" help="(-out_type) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 <option value="mzData">mzData</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 <option value="mzXML">mzXML</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 <option value="mzML">mzML</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 <option value="dta2d">dta2d</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 <option value="mgf">mgf</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 <option value="featureXML">featureXML</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 <option value="consensusXML">consensusXML</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 <option value="edta">edta</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 <option value="csv">csv</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 <param name="param_write_mzML_index" type="boolean" truevalue="-write_mzML_index" falsevalue="" checked="false" optional="True" label="Add an index to the file when writing mzML files (default: no index)" help="(-write_mzML_index) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 <param name="param_TIC_DTA2D" type="boolean" truevalue="-TIC_DTA2D" falsevalue="" checked="false" optional="True" label="Export the TIC instead of the entire experiment in mzML/mzData/mzXML -&gt; DTA2D conversions" help="(-TIC_DTA2D) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 <param name="param_MGF_compact" type="boolean" truevalue="-MGF_compact" falsevalue="" 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) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 <param name="param_process_lowmemory" type="boolean" truevalue="-process_lowmemory" falsevalue="" 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)" help="(-process_lowmemory) &lt;br&gt;Note: this flag will prevent conversion from spectra to chromatograms"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 <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
77 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <data name="param_out" metadata_source="param_in" format="input"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 Converts between different MS file formats.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_FileConverter.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 </tool>