annotate QCExtractor.xml @ 12:c8d22d876c75 draft

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
author galaxyp
date Thu, 01 Dec 2022 19:00:36 +0000
parents 7468a1c8ca6e
children 9a527fdadffc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
5
564fe41ff448 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 58476cadaaf10b494317a604ad81d41c2d15f29b
galaxyp
parents: 1
diff changeset
2 <!--This is a configuration file for the integration of a tools into Galaxy (https://galaxyproject.org/). This file was automatically generated using CTDConverter.-->
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
3 <!--Proposed Tool Section: [Utilities]-->
12
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
4 <tool id="QCExtractor" name="QCExtractor" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
5 <description>Extracts a table attachment to a given qc parameter.</description>
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
6 <macros>
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
7 <token name="@EXECUTABLE@">QCExtractor</token>
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
8 <import>macros.xml</import>
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
9 </macros>
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
10 <expand macro="requirements"/>
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
11 <expand macro="stdio"/>
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
12 <command detect_errors="exit_code"><![CDATA[@QUOTE_FOO@
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
13 @EXT_FOO@
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
14 #import re
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
15
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
16 ## Preprocessing
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
17 mkdir in &&
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
18 ln -s '$in' 'in/${re.sub("[^\w\-_]", "_", $in.element_identifier)}.$gxy2omsext($in.ext)' &&
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
19 #if $run:
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
20 mkdir run &&
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
21 ln -s '$run' 'run/${re.sub("[^\w\-_]", "_", $run.element_identifier)}.$gxy2omsext($run.ext)' &&
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
22 #end if
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
23 mkdir out_csv &&
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
24
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
25 ## Main program call
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
26
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
27 set -o pipefail &&
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
28 @EXECUTABLE@ -write_ctd ./ &&
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
29 python3 '$__tool_directory__/fill_ctd.py' '@EXECUTABLE@.ctd' '$args_json' '$hardcoded_json' &&
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
30 @EXECUTABLE@ -ini @EXECUTABLE@.ctd
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
31 -in
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
32 'in/${re.sub("[^\w\-_]", "_", $in.element_identifier)}.$gxy2omsext($in.ext)'
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
33 #if $run:
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
34 -run
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
35 'run/${re.sub("[^\w\-_]", "_", $run.element_identifier)}.$gxy2omsext($run.ext)'
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
36 #end if
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
37 -out_csv
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
38 'out_csv/output.${gxy2omsext("csv")}'
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
39
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
40 ## Postprocessing
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
41 && mv 'out_csv/output.${gxy2omsext("csv")}' '$out_csv'
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
42 #if "ctd_out_FLAG" in $OPTIONAL_OUTPUTS
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
43 && mv '@EXECUTABLE@.ctd' '$ctd_out'
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
44 #end if]]></command>
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
45 <configfiles>
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
46 <inputs name="args_json" data_style="paths"/>
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
47 <configfile name="hardcoded_json"><![CDATA[{"log": "log.txt", "threads": "\${GALAXY_SLOTS:-1}", "no_progress": true}]]></configfile>
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
48 </configfiles>
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
49 <inputs>
12
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
50 <param argument="-in" type="data" format="qcml" optional="false" label="Input qcml file" help=" select qcml data sets(s)"/>
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
51 <param argument="-qp" type="text" optional="false" value="" label="Target attachment qp" help="">
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
52 <expand macro="list_string_san" name="qp"/>
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
53 </param>
12
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
54 <param argument="-run" type="data" format="mzml" optional="true" label="The file that defined the run under which the qp for the attachment is aggregated as mzML file" help="The file is only used to extract the run name from the file name select mzml data sets(s)"/>
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
55 <param argument="-name" type="text" optional="true" value="" label="If no file for the run was given (or if the target qp is contained in a set), at least a name of the target run/set containing the the qp for the attachment has to be given" help="">
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
56 <expand macro="list_string_san" name="name"/>
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
57 </param>
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
58 <expand macro="adv_opts_macro">
12
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
59 <param argument="-force" type="boolean" truevalue="true" falsevalue="false" checked="false" label="Overrides tool-specific checks" help=""/>
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
60 <param argument="-test" type="hidden" optional="true" value="False" label="Enables the test mode (needed for internal use only)" help="">
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
61 <expand macro="list_string_san" name="test"/>
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
62 </param>
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
63 </expand>
10
7468a1c8ca6e "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 55a2aeba8bfd8a6910630721de9857dcdfe05d3c"
galaxyp
parents: 8
diff changeset
64 <param name="OPTIONAL_OUTPUTS" type="select" optional="true" multiple="true" label="Optional outputs">
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
65 <option value="ctd_out_FLAG">Output used ctd (ini) configuration file</option>
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
66 </param>
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
67 </inputs>
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
68 <outputs>
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
69 <data name="out_csv" label="${tool.name} on ${on_string}: out_csv" format="csv"/>
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
70 <data name="ctd_out" format="xml" label="${tool.name} on ${on_string}: ctd">
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
71 <filter>OPTIONAL_OUTPUTS is not None and "ctd_out_FLAG" in OPTIONAL_OUTPUTS</filter>
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
72 </data>
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
73 </outputs>
12
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
74 <tests><!--TODO-->
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
75 </tests>
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
76 <help><![CDATA[Extracts a table attachment to a given qc parameter.
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
77
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
78
12
c8d22d876c75 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 3d1e5f37fd16524a415f707772eeb7ead848c5e3
galaxyp
parents: 10
diff changeset
79 For more information, visit http://www.openms.de/doxygen/release/2.8.0/html/UTILS_QCExtractor.html]]></help>
8
ef970936ce43 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 020906fb54bde7fc143c356f41975c378a741315"
galaxyp
parents: 7
diff changeset
80 <expand macro="references"/>
0
6a16b2a96a5e planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
81 </tool>