annotate methylGSA.xml @ 1:51dbd3d869ce draft default tip

Uploaded
author mora-lab
date Thu, 20 May 2021 08:44:37 +0000
parents 009f5b03ca69
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
1 <tool id="methylGSA" name="methylGSA" version="0.1.0" python_template_version="3.5">
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
2 <description>Gene Set Analysis for DNA Methylation data</description>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
3
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
4 <requirements>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
5 <requirement type="package" version="0.6.0">bioconductor-IlluminaHumanMethylationEPICanno.ilm10b4.hg19</requirement>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
6 <requirement type="package" version="0.6.0">bioconductor-IlluminaHumanMethylation450kanno.ilmn12.hg19</requirement>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
7 <requirement type="package" version="1.8.0">bioconductor-methylGSA</requirement>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
8 <requirement type="package" version="1.20.3">r-getopt</requirement>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
9 </requirements>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
10
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
12 Rscript '$__tool_directory__/methylGSA.R'
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
13 --data_file '$data_file'
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
14 --test_method '$method'
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
15 --array_type '$array_type'
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
16 --group '$Group'
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
17 --GS_list '$geneset'
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
18 --minsize '$minSize'
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
19 --maxsize '$maxSize'
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
20 --result '$gsa_result'
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
21
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
22 ]]></command>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
23
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
24 <inputs>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
25 <param name="data_file" type="data" format="txt" label="CpG IDs and their p-value" help="A text file with two columns: The CpG IDs and their p-values." />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
26 <param name="array_type" type="select" label="Array_type" help="450K or EPIC." >
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
27 <option value="450K">450K</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
28 <option value="EPIC">EPIC</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
29 </param>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
30 <param name="Group" type="select" label="Group" help="See help for more details.">
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
31 <option value="all">all</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
32 <option value="body">body</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
33 <option value="promoter1">promoter1</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
34 <option value="promoter2">promoter2</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
35 </param>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
36 <param name="method" type="select" label="Test method" display="radio" help="See help for more details." >
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
37 <option value="methylglm">methylglm</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
38 <option value="gometh">gometh</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
39 <option value="RRA_ORA">RRA(ORA)</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
40 <option value="RRA_GSEA">RRA(GSEA)</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
41 </param>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
42 <param name="geneset" type="select" label="Gene sets" help="Select gene sets to test." >
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
43 <option value="GO">Gene Ontology</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
44 <option value="KEGG">KEGG</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
45 <option value="Reactome">Reactome</option>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
46 </param>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
47
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
48 <param name="minSize" type="integer" label="Minimum gene set size" value="15" min="1" max="1000" help="Gene sets with less than this number of elements will not be included in the analysis." />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
49 <param name="maxSize" type="integer" label="Maximum gene set size" value="500" min="1" max="1000" help="Gene sets with more than this number of elements will not be included in the analysis." />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
50
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
51 </inputs>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
52
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
53 <outputs>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
54 <data name="gsa_result" format="csv" label="methylGSA_result" />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
55 </outputs>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
56
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
57 <tests>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
58 <test>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
59 <param name="data_file" value="cpg.csv" ftype="txt" />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
60 <param name="array_type" value="450K"/>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
61 <param name="Group" value="all" />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
62 <param name="method" value="methylglm" />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
63 <param name="geneset" value="GO" />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
64 <param name="minSize" value="15" />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
65 <param name="maxSize" value="500" />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
66 <output name="gsa_result" file="methylGSA_result.csv" ftype="csv" />
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
67 </test>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
68 </tests>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
69
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
70 <help><![CDATA[
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
71
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
72 .. class:: infomark
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
73
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
74 **What it does**
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
75
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
76 **methylGSA** is a tool for gene set testing with length bias adjustment for DNA methylation data.
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
77 It allows users to identify enriched or over-represented gene sets or pathways from the Gene
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
78 Ontology, KEGG and Reactome databases.
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
79
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
80 -------
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
81
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
82 =========
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
83 **Input**
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
84 =========
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
85
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
86 **CpG IDs and their p-value**
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
87
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
88 Users are expected to upload a txt file with two columns: The fist column with the CpG IDs, and the second column with the p-values correspond to the CpGs. For example:
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
89
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
90 =========== ===========
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
91 cg13869341 0.307766
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
92 cg14008030 0.257672
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
93 cg12045430 0.552322
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
94 cg20826792 0.056383
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
95 cg00381604 0.468549
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
96 cg20253340 0.483770
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
97 cg21870274 0.812402
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
98 =========== ===========
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
99
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
100 Files should be no more than 100MB.
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
101
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
102 **array_type**
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
103
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
104 `450K`: Illumina 450 K Beadchip
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
105
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
106 `EPIC`: Illumina EPIC Beadchip
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
107
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
108 **Group**
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
109
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
110 **Group** defines the type of CpG to be considered by the `methylRRA` or `methylglm` functions. By default,
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
111 group is set to `all`, which means that all CpGs are considered regardless of their gene group.
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
112 If group is set to `body`, only CpGs on gene body will be considered. If group is `promoter1`
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
113 or `promoter2`, only CpGs on promoters will be considered.
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
114 Based on the annotation in IlluminaHumanMethylation450kanno.ilmn12.hg19
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
115 and IlluminaHumanMethylationEPICanno.ilm10b4.hg19, `body`, `promoter1` and `promoter2` are defined as:
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
116
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
117 * body: CpGs whose gene group correspond to “Body” or “1stExon”
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
118 * promoter1: CpGs whose gene group correspond to “TSS1500” or “TSS200”
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
119 * promoter2: CpGs whose gene group correspond to “TSS1500”, “TSS200”, “1stExon”, or “5’UTR”
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
120
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
121 **Test method**
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
122
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
123 * methylglm: Implement logistic regression adjusting for number of probes in enrichment analysis
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
124 * gometh: Gene ontology testing for Illumina methylation array data
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
125 * RRA(ORA): Enrichment analysis with ORA method after adjusting multiple p-values of each gene by Robust Rank Aggregation
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
126 * RRA(GSEA): Enrichment analysis with GSEA method after adjusting multiple p-values of each gene by Robust Rank Aggregation
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
127
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
128 **Gene sets tested**
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
129
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
130 * Gene Ontology: http://www.geneontology.org
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
131 * KEGG (Kyoto Encyclopedia of Genes and Genomes): https://www.genome.jp/kegg/
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
132 * Reactome: https://reactome.org
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
133
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
134 ==========
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
135 **Output**
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
136 ==========
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
137
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
138 **methylGSA_result**
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
139 This file is a csv file which contains gene set tests results.
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
140
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
141 ]]></help>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
142
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
143 <citations>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
144 <citation type="doi">10.1093/bioinformatics/bty892</citation>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
145 </citations>
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
146
009f5b03ca69 Uploaded
mora-lab
parents:
diff changeset
147 </tool>