annotate macros.xml @ 2:2c218a253d56 draft default tip

"planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
author malex
date Thu, 29 Jul 2021 20:48:10 +0000
parents ec9ee8edb84d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
1 <?xml version="1.0" ?>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
2 <macros>
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
3 <token name="@WRAPPER_VERSION@">21.7.22</token>
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
4 <xml name="requirements">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
5 <requirements>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
6 <requirement type="package" version="@WRAPPER_VERSION@">gait-gm</requirement>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
7 <yield/>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
8 </requirements>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
9 </xml> <xml name="citations">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
10 <citations>
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
11 <citation type="bibtex">@ARTICLE{Mor21,gaitgm
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
12 author = {Danille E Mor, Francisco Huertas, Alison M Morse, Rachel Kaletsky, Coleen T Murphy, Vrinda Kalia, Gary W Miller, Oleksandr Moskalenko, Ana conesa, Lauren M McIntyre},
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
13 title = {GAIT-GM integrative cross-omics analyses reveal cholinergic defects in a C. elegans model of Parkinson's disease},
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
14 journal = {BMC Genomics},
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
15 year = {submitted}
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
16 }</citation>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
17 </citations>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
18 </xml>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
19
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
20 <token name="@TIP_AND_WARNING@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
21 **TIP:** If your data is not TAB delimited, use *Text Manipulation-&gt;Convert*
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
22
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
23 **WARNINGS:**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
24
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
25 (1) SampleIDs in the wide data that have no matching name in the design file, as well as sampleIDs in the design file that have no match in data will be included in the analysis.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
26 (2) This script automatically removes spaces and special characters from strings.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
27 (3) If a compound/feature name starts with a number it will prepend an '_'.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
28 (4) Input names are case sensitive and must match exactly (e.g use 'Feature' not 'feature').
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
29 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
30 <token name="@WIDE@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
31 **Wide Formatted Dataset**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
32
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
33 A wide formatted dataset that contains measurements for each sample:
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
34
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
35 +---------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
36 | Feature | sample1 | sample2 | sample3 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
37 +=========+=========+=========+=========+=====+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
38 | one | 10 | 20 | 10 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
39 +---------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
40 | two | 5 | 22 | 30 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
41 +---------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
42 | three | 30 | 27 | 2 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
43 +---------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
44 | four | 32 | 17 | 8 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
45 +---------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
46 | ... | ... | ... | ... | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
47 +---------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
48
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
49 **NOTE:** The 'Feature' column defines the rows within a wide formatted dataset.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
50 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
51 <token name="@METADATA@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
52 **Design File**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
53
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
54 A Design file relating samples to various groups/treatment:
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
55
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
56 +----------+--------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
57 | sampleID | group |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
58 +==========+========+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
59 | sample1 | g1 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
60 +----------+--------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
61 | sample2 | g1 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
62 +----------+--------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
63 | sample3 | g1 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
64 +----------+--------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
65 | sample4 | g2 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
66 +----------+--------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
67 | sample5 | g2 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
68 +----------+--------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
69 | sample6 | g2 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
70 +----------+--------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
71 | ... | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
72 +----------+--------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
73
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
74 **NOTE:** You must have a column named **sampleID** and the values in this column must match the column names in the wide dataset.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
75 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
76 <token name="@FLAGS@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
77 **Flag File:**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
78
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
79 A wide formated dataset that contains flags for each sample or feature:
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
80
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
81 +----------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
82 | Feature | flag_A | flag_B | flag_C | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
83 +==========+=========+=========+=========+=====+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
84 | one | 0 | 0 | 0 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
85 +----------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
86 | two | 0 | 1 | 1 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
87 +----------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
88 | three | 0 | 1 | 0 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
89 +----------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
90 | four | 1 | 0 | 0 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
91 +----------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
92 | ... | ... | ... | ... | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
93 +----------+---------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
94
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
95 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
96 <token name="@MZRTFILE@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
97 **M/Z RT File:**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
98
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
99 A wide formated dataset that contains M/Z and RT measurements for each sample:
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
100
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
101 +----------+--------+----------------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
102 | sampleID | M/Z | Retention Time |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
103 +==========+========+================+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
104 | sample1 | 0.1556 | 0.253618769 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
105 +----------+--------+----------------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
106 | sample2 | 0.1675 | 0.327658519 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
107 +----------+--------+----------------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
108 | sample3 | 0.1341 | 0.156587769 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
109 +----------+--------+----------------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
110 | sample4 | 0.2341 | 0.153658165 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
111 +----------+--------+----------------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
112 | sample5 | 0.4557 | 0.315765787 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
113 +----------+--------+----------------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
114 | sample6 | 0.1879 | 0.253655765 |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
115 +----------+--------+----------------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
116 | ... | ... | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
117 +----------+--------+----------------+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
118
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
119 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
120 <token name="@GROUP_OPTIONAL@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
121 **Group/Treatment [Optional]**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
122
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
123 - Name of the column in your Design File that contains group classifications.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
124 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
125 <token name="@GROUP@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
126 **Group/Treatment**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
127
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
128 - Name of the column in your Design File that contains group classifications.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
129 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
130 <token name="@UNIQID@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
131 **Unique Feature ID**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
132
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
133 - Name of the column in your Wide Dataset that has unique Feature IDs.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
134 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
135 <token name="@RUNORDER@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
136 **Run Order ID**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
137
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
138 - The column name in your Design file that contains the order samples were run.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
139 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
140 <token name="@RUNORDER_OPTIONAL@">
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
141 **Run Order ID [Optional]**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
142
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
143 - The column name in your Design file that contains the order samples were run.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
144 </token>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
145 </macros>