annotate add_pval_flags.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
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
1 <tool id="secimtools_add_pval_flags" name="Add Binary (0/1) P-value Flags" version="@WRAPPER_VERSION@">
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
2 <description>using custom thresholds</description>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
3 <macros>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
4 <import>macros.xml</import>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
5 </macros>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
6 <expand macro="requirements" />
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
8 add_pval_flags.py
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
9 -de=$DE_Dataset
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
10 -id=$uniqID
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
11 -p=$pvalue
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
12 -t=$thresholds
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
13 -o=$output
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
14 -fl=$flags
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
15 ]]></command>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
16 <inputs>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
17 <param name="DE_Dataset" type="data" format="tabular" label="Select Dataset containing p-values from your history"/>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
18 <param name="uniqID" type="text" size="30" value="" label="Unique FeatureID" help="Name of the column in your Dataset that contains unique FeatureIDs."/>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
19 <param name="pvalue" type="text" size="30" value="" label="P-Value" help="Name of the column containing your p-values."/>
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
20 <param name="thresholds" type="text" size="30" value="0.1,0.05,0.01" label="P-Value Thresholds" help="Enter the threshold(s). P-values less than the given threshold(s) will be flagged with a 1. Separate more than 1 threshold value with a comma; no spaces allowed. Default values are 0.1,0.05,0.01"/>
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
21 </inputs>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
22 <outputs>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
23 <data format="tabular" name="output" label="${tool.name} on ${on_string}: Output File"/>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
24 <data format="tabular" name="flags" label="${tool.name} on ${on_string}: Flags File"/>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
25 </outputs>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
26 <tests>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
27 <test>
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
28 <param name="DE_Dataset" value="limma_voom_gene.tsv"/>
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
29 <param name="uniqID" value="UniqueID"/>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
30 <param name="pvalue" value="P.Value"/>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
31 <param name="thresholds" value="0.1,0.05,0.01"/>
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
32 <output name="output" file="add_flags_gene_output.tsv"/>
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
33 <output name="flags" file="add_flags_gene_flags.tsv"/>
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
34 </test>
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
35 <test>
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
36 <param name="DE_Dataset" value="limma_voom_metabolite.tsv"/>
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
37 <param name="uniqID" value="UniqueID"/>
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
38 <param name="pvalue" value="P.Value"/>
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
39 <param name="thresholds" value="0.1,0.05,0.01"/>
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
40 <output name="output" file="add_flags_metabolite_output.tsv"/>
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
41 <output name="flags" file="add_flags_metabolite_flags.tsv"/>
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
42 </test>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
43 </tests>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
44 <help><![CDATA[
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
45 **Tool Description**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
46
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
47 This tool generates 0/1 indicator variables to identify (‘flag’) p-values less than a user-specified threshold or less than the
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
48 default values of 0.1, 0.05 and 0.01. The flag_threshold variable is equal to 1 if the p-value is less than or equal to the
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
49 threshold and equal to 0 if greater than the threshold. You can flag nominal p-values or p-values after correction for multiple testing.
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
50
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
51 --------------------------------------------------------------------------------
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
52
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
53 **INPUT**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
54
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
55 **Example of a dataset containing p-values**
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 +-----------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
58 | FeatureID | P-value | FDR | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
59 +===========+=========+=========+=====+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
60 | one | 2.02e-6 | 1.83e-6 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
61 +-----------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
62 | two | 2.87e-5 | 0.0063 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
63 +-----------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
64 | three | 0.001 | 0.19 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
65 +-----------+---------+---------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
66 | four | 0.22 | 0.99 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
67 +-----------+---------+---------+-----+
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 +-----------+---------+---------+-----+
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 **P-value**
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 Name of the column in your Dataset that contains p-values.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
74
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
75 **P-value Threshold**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
76
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
77 P-values less than the threshold will be flagged with a 1. P-values greater than the threshold will be flagged with a 0.
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 **NOTE:** More than one threshold value is allowed. Separate flags will be generated for each threshold value.
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
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
83 **OUTPUT**
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
84
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
85 Two output files are generated from the Add Binary (0/1) P-value Flags tool:
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
86
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
87 **Output File.** A TSV file containing the same columns as the Input Dataset plus an additional column(s) containing 0/1 binary indicators for whether the P-value was less that the user-specified threshold. The indicator columns are named by appending the user-specified threshold to "Flag" prefix (e.g. Flag_user-specified threshold, Flag_0.10).
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
88
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 | FeatureID | p-value | FDR | Flag_0.2 | Flag_0.05 | ... |
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 | one | 2.02e-6 | 1.83e-6 | 1 | 1 | ... |
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 | two | 2.87e-5 | 0.0063 | 1 | 1 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
95 +-----------+---------+---------+----------+-----------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
96 | three | 0.001 | 0.19 | 1 | 0 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
97 +-----------+---------+---------+----------+-----------+-----+
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
98 | four | 0.22 | 0.99 | 0 | 0 | ... |
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
99 +-----------+---------+---------+----------+-----------+-----+
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
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
103 **Flag Table.** A TSV file containing only the FeatureID column from the input dataset and the tool-generated binary indicator flags.
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
104
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 | FeatureID | Flag_0.2 | Flag_0.05 | ... |
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 | one | 1 | 1 | ... |
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 | two | 1 | 1 | ... |
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 | three | 1 | 0 | ... |
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 | four | 0 | 0 | ... |
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
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
119 ]]></help>
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
120 <citations>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
121 <citation type="bibtex">@ARTICLE{Kirpich17secimtools,
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
122 author = {Alexander S. Kirpich, Miguel Ibarra, Oleksandr Moskalenko, Justin M. Fear, Joseph Gerken, Xinlei Mi, Ali Ashrafi, Alison M. Morse, Lauren M. McIntyre},
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
123 title = {SECIMTools: A suite of Metabolomics Data Analysis Tools},
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
124 journal = {BMC Bioinformatics},
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
125 year = {2018}
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
126 }</citation>
2
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
127 <citation type="bibtex">@article{Mor2021GaitGM,
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
128 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
129 author={Mor, DE and Huertas, F and Morse, AM and Kaletsky, R and Murphy, CT and Kalia, V and Miller, GW and Moskalenko, O and Conesa, A and McIntyre, LM},
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
130 journal={BMC Genomics},
2c218a253d56 "planemo upload for repository https://github.com/secimTools/gait-gm/tree/main/galaxy commit 758394addb95b09e794132a23a1f7e95ba39df0b"
malex
parents: 1
diff changeset
131 year={submitted},
1
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
132 }</citation>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
133 </citations>
ec9ee8edb84d Initial upload of 21.6.10 release.
malex
parents:
diff changeset
134 </tool>