annotate metaquantome_sample.xml @ 5:5bc492a15b8b draft

planemo upload
author galaxyp
date Thu, 07 Feb 2019 17:54:28 -0500
parents
children a1df90e6e7d4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
1 <?xml version='1.0' encoding='utf-8'?>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
2 <tool id="sample" name="metaQuantome: create samples file" version="@VERSION@.3">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
3 <description></description>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
4 <macros>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
5 <token name="@VERSION@">1.1.2</token>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
6 </macros>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
7 <requirements>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
8 <requirement type="package" version="@VERSION@">megahit</requirement>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
9 </requirements>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
10 <version_command>megahit --version</version_command>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
12 #set $samp_header = 'group\tcolnames'
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
13 echo -e '${samp_header}' > samp_file.tab;
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
14 #if $samps_args.samps_src == 'build':
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
15 #for $s in $samps_args.samps
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
16 #set $sample = str($s.group_name) + '\t' + str($s.col_names)
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
17 echo -e '${sample}' >> samp_file.tab;
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
18 #end for
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
19 #else:
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
20 #for $s in $samps_args.samps
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
21 cat ${samps_args.file} | cut -f ${s.col_names} |
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
22 head -n 1 | tr '\t' ',' |
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
23 cat <(echo -e -n "${s.group_name}\t") - >> samp_file.tab;
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
24 #end for
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
25 #end if
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
26 ]]></command>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
27 <inputs>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
28 <conditional name="samps_args">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
29 <param name="samps_src" type="select" label="Sample file creation method">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
30 <option value="build">Specify samples</option>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
31 <option value="history">Select samples from existing file's header</option>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
32 </param>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
33 <when value="build">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
34 <repeat name="samps" title="Samples">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
35 <param name="group_name" type="text" label="Group name" />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
36 <param name="col_names" type="text" label="Column" help="Specify the column names of the sample file. Use commas to separate multiple columns." />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
37 </repeat>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
38 </when>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
39 <when value="history">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
40 <param name="file" type="data" format="tabular" label="File with group name headers" help="Ex: moFF tool output (headers: peptide X737NS X737WS)" />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
41 <repeat name="samps" title="Samples">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
42 <param name="group_name" type="text" label="Group name" />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
43 <param name="col_names" type="data_column" multiple="true" data_ref="file" label="Column" help="Specify the column indices of the file's header" />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
44 </repeat>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
45 </when>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
46 </conditional>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
47 </inputs>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
48 <outputs>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
49 <data format="tabular" name="samples_file" from_work_dir="samp_file.tab" label="${tool.name} ${on_string}" />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
50 </outputs>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
51 <tests>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
52 <test>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
53 <param name="samps_src" value="build" />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
54 <repeat name="samps">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
55 <param name="group_name" value="NS"/>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
56 <param name="col_names" value="X737NS,X852NS,X867NS"/>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
57 </repeat>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
58 <repeat name="samps">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
59 <param name="group_name" value="WS"/>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
60 <param name="col_names" value="X737WS,X852WS,X867WS"/>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
61 </repeat>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
62 <output name="samples_file" file="samples.tab" ftype="tabular"/>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
63 </test>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
64 <test>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
65 <param name="samps_src" value="history" />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
66 <param name="file" value="int_737_test.tab" ftype="tabular" />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
67 <repeat name="samps">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
68 <param name="group_name" value="NS"/>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
69 <param name="col_names" value="3,5,7"/>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
70 </repeat>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
71 <repeat name="samps">
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
72 <param name="group_name" value="WS"/>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
73 <param name="col_names" value="2,4,6"/>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
74 </repeat>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
75 <output name="samples_file" file="samples.tab" ftype="tabular" />
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
76 </test>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
77 </tests>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
78 <help><![CDATA[
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
79 metaQuantome: create samples file
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
80 ===================
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
81
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
82 The *create samples file* module is used to generate the *samples file* input file for the metaQuantome workflow. This input file is used to specify which column names are affilated with which experimental groups.
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
83
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
84 *Create samples file*
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
85
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
86 ===== ====================
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
87 group colnames
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
88 ===== ====================
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
89 NS X737NS,X852NS,X867NS
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
90 WS X737WS,X852WS,X867WS
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
91 ===== ====================
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
92
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
93
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
94 There are two methods for generating this input file:
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
95
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
96 1. **Specify Samples** You may specify the samples by providing the group names (ex: NS *no sucrose* and WS *with sucrose*) and each of their affilated column names (ex: X737WS, X737NS, etc...) from the input files (e.g., peptide intensity *int.tab*).
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
97
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
98 2. **Select samples from existing file's header** Alternatively, you can indicate the column indices of the selected headers for each experimental group (ex: columns 1, 3, and 5 for NS; columns 2, 4, and 6 for WS). You need to specify which file from the history you are referencing. An example is shown below.
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
99
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
100 *Example int.tab file*
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
101 ============ ====== ====== ====== ====== ====== ======
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
102 peptide X737WS X737NS X852WS X852NS X867WS X867NS
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
103 ============ ====== ====== ====== ====== ====== ======
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
104 LPGQQHGTPSAK 1 2 3 4 5 6
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
105 ELPGLAALTDK 7 8 9 10 11 12
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
106 ============ ====== ====== ====== ====== ====== ======
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
107
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
108
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
109 Questions, Comments, Problems, Kudos
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
110 ------------------------------------
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
111
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
112 Please file any issues at https://github.com/galaxyproteomics/tools-galaxyp/issues.
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
113 ]]></help>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
114 <citations>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
115 <citation type="doi">10.1093/bioinformatics/btv033</citation>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
116 </citations>
5bc492a15b8b planemo upload
galaxyp
parents:
diff changeset
117 </tool>