annotate ms2pf_it.xml @ 0:b58b229c4cbf draft

planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
author lain
date Fri, 03 Mar 2023 14:10:24 +0000
parents
children 7e3085fc60c1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
1 <tool id="ms_to_peakforest_it" name="MS To PeakForest IT" tool_type="interactive" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.09">
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
2 <description>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
3 adds you MS spectrum to peakforest.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
4 </description>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
5 <macros>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
6 <token name="@VERSION_SUFFIX@">0</token>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
7 <import>macros.xml</import>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
8 </macros>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
9 <requirements>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
10 <requirement type="package" version="3.10">python</requirement>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
11 <requirement type="package">pyyaml</requirement>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
12 </requirements>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
13 <entry_points>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
14 <entry_point name="MS to PeakForest, with ${','.join(str(i.name) for i in $input)}" requires_domain="True">
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
15 <port>8000</port>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
16 <url>/</url>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
17 </entry_point>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
18 </entry_points>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
19 <version_command>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
20 <![CDATA[
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
21 python3 '$__tool_directory__/server.py' --version | head -n 1
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
22 ]]>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
23 </version_command>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
24 <command>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
25 @MS2PF_COMMON_CMD@
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
26 </command>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
27 <inputs>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
28 <expand macro="ms2pf_inputs" />
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
29 </inputs>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
30 <outputs>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
31 <data name="ms2pfout" format="txt"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
32 label="${tool.name} on ${','.join(i.name for i in $input)}"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
33 />
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
34 <data name="json_output" format="json"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
35 label="JSON ${tool.name} on ${','.join(i.name for i in $input)}.json"
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
36 >
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
37 <filter>do_output_json</filter>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
38 </data>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
39 </outputs>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
40 <tests>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
41 </tests>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
42 <help>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
43 <![CDATA[
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
44 .. class:: infomark
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
45
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
46 **Authors** Lain Pavot (lain.pavot@inrae.fr)
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
47
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
48 .. class:: infomark
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
49
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
50 ---------------------------------------------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
51
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
52 ==============
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
53 MS2 validation
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
54 ==============
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
55
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
56 -----------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
57 Description
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
58 -----------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
59
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
60
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
61 -----------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
62 Workflow position
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
63 -----------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
64
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
65 --------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
66 Upstream tools
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
67 --------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
68
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
69 +-------------------------+-----------------+--------+------------+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
70 | Name | output file | format | parameter |
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
71 +=========================+=================+========+============+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
72 | ms2snoop | tsv | TSV | NA |
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
73 +-------------------------+-----------------+--------+------------+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
74 | abinitfragnot | tsv | TSV | NA |
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
75 +-------------------------+-----------------+--------+------------+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
76
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
77 ----------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
78 Downstream tools
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
79 ----------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
80
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
81 +-------------------------+-----------------+--------+------------+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
82 | Name | output file | format | parameter |
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
83 +=========================+=================+========+============+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
84 | NA | NA | NA | NA |
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
85 +-------------------------+-----------------+--------+------------+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
86
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
87
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
88 -----------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
89 Input files
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
90 -----------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
91
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
92 +----------------------------------------------+------------+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
93 | Parameter : num + label | Format |
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
94 +===========================+==================+============+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
95 | Output from ms2snoop or fragnot | TSV,CSV |
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
96 +----------------------------------------------+------------+
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
97
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
98 ----------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
99 Parameters
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
100 ----------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
101
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
102 input
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
103 | The file to process. Should contain spectra with mz, intensities and
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
104 annotations
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
105
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
106 method
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
107 | The method parameter tells which method was used. The value will
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
108 be the default value in the peakforest form.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
109
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
110 peakforest-url
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
111 | The peakforest-url parameter tells which instance of peakforest to
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
112 interact with
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
113
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
114 scan_type
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
115 | The scan_type parameter which kind of scan was used. The value will
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
116 be the default value in the peakforest form.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
117
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
118 polarity
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
119 | The polarity parameter which polarity was used. The value will
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
120 be the default value in the peakforest form.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
121
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
122 name
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
123 | The name parameter provides names each spectra.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
124
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
125
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
126 ------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
127 Output files
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
128 ------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
129
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
130 There is not output file. When you run this tool, keep waiting until the
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
131 « click here to display » link appears.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
132
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
133 Click on the link to display peakforest form.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
134
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
135 --------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
136 Changelog/News
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
137 --------------
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
138
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
139 1.0.0
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
140 | First version, published on the toolshed.
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
141
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
142 ]]>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
143 </help>
b58b229c4cbf planemo upload commit 523a9c8df173302ad38e9f15e7d82eab01736551-dirty
lain
parents:
diff changeset
144 </tool>