annotate msigdb_kegg_geneSet.xml @ 1:0c0d33699925 draft default tip

Uploaded
author mora-lab
date Thu, 20 May 2021 08:37:05 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
1 <tool id="msigdb_kegg_geneSet" name="Get gene sets from Msigdb/KEGG" version="0.1.0">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
2 <description>Get a geneSet object from Msigdb or KEGG</description>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
3
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
4 <requirements>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
5 <requirement type="package" version="1.30.0">bioconductor-KEGGREST</requirement>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
6 <requirement type="package" version="7.2.1">r-msigdbr</requirement>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
7 <requirement type="package" version="1.52.1">bioconductor-GSEABase</requirement>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
8 <requirement type="package" version="1.20.3">r-getopt</requirement>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
9 </requirements>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
10
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
12 Rscript '$__tool_directory__/msigdb_kegg_geneSet.R'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
13
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
14 --source '$input_args.source'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
15
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
16 #if str($input_args.source) == 'KEGG':
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
17 --organism '$input_args.organism'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
18 #end if
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
19
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
20 #if str($input_args.source) == 'Msigdb':
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
21 --species '$input_args.species'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
22 --category '$input_args.cat.category'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
23 --geneIdType '$input_args.geneIdType'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
24
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
25 #if str($input_args.cat.category) == 'C2':
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
26 --subcategory '$input_args.cat.subcategory'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
27 #end if
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
28
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
29 #if str($input_args.cat.category) == 'C3':
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
30 --subcategory '$input_args.cat.subcategory'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
31 #end if
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
32
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
33 #if str($input_args.cat.category) == 'C4':
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
34 --subcategory '$input_args.cat.subcategory'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
35 #end if
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
36
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
37 #if str($input_args.cat.category) == 'C5':
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
38 --subcategory '$input_args.cat.subcategory'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
39 #end if
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
40
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
41 #end if
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
42
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
43 --outputRData '$outputRData'
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
44
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
45 ]]></command>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
46
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
47 <inputs>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
48 <conditional name="input_args">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
49 <param type="select" name="source" label="KEGG or MSigDB" help="Choose gene set from KEGG or MSigDB.">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
50 <option value="KEGG" selected="true">KEGG</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
51 <option value="Msigdb" >MSigDB</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
52 </param>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
53
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
54 <when value="KEGG">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
55 <param type="text" name="organism" value="hsa" label="organism" help="A KEGG organism code (see https://www.kegg.jp/kegg/catalog/org_list.html). For example, human is `hsa`, Mus musculus is `mmu`."/>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
56 </when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
57 <when value="Msigdb">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
58 <param type="select" name="species" label="Species" help="Species name, such as Homo sapiens or Mus musculus.">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
59 <option value="Homo sapiens" selected="true">human (H sapiens)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
60 <option value="Bos taurus">cattle (B taurus)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
61 <option value="Caenorhabditis elegans">roundworm (C elegans)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
62 <option value="Canis lupus familiaris">dog (C familiaris)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
63 <option value="Danio rerio">zebrafish (D rerio)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
64 <option value="Drosophila melanogaster">fruit fly (D melanogaster)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
65 <option value="Gallus gallus">chicken (G gallus)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
66 <option value="Mus musculus">house mouse (M musculus)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
67 <option value="Rattus norvegicus">Rat (R norvegicus)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
68 <option value="Saccharomyces cerevisiae">baker's or brewer's yeast (S cerevisiae)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
69 <option value="Sus scrofa">pig (S scrofa)</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
70 </param>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
71
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
72 <conditional name="cat">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
73 <param type="select" name="category" label="Category" help="MSigDB collection abbreviation, such as H or C1.">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
74 <option value="H">h: hallmark gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
75 <option value="C1">c1: positional gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
76 <option value="C2" selected="true">c2: curated gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
77 <option value="C3">c3: regulatory target gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
78 <option value="C4">c4: computational gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
79 <option value="C5">c5: Ontology gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
80 <option value="C6">c6: oncogenic signature gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
81 <option value="C7">c7: immunologic signature gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
82 <option value="C8">c8: cell type signature gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
83 </param>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
84 <when value="H"></when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
85 <when value="C1"></when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
86 <when value="C2">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
87 <param type="select" name="subcategory" label="Sub Category" multiple="true" display="checkboxes">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
88 <option value="CGP">chemical and genetic perturbations</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
89 <option value="CP">all canonical pathways</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
90 <option value="CP:BIOCARTA">BioCarta gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
91 <option value="CP:KEGG" selected="true">KEGG gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
92 <option value="CP:PID">PID gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
93 <option value="CP:REACTOME">Reactome gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
94 <option value="CP:WIKIPATHWAYS">WikiPathways gene sets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
95 </param>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
96 </when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
97
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
98 <when value="C3">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
99 <param type="select" name="subcategory" label="Sub Category" multiple="true" display="checkboxes">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
100 <option value="MIR:MIR_Legacy">legacy microRNA targets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
101 <option value="MIR:MIRDB">MIRDB targets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
102 <option value="TFT:GTRD">GTRD targets </option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
103 <option value="TFT:TFT_Legacy">legacy transcription factor targets</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
104 </param>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
105 </when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
106
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
107 <when value="C4">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
108 <param type="select" name="subcategory" label="Sub Category" multiple="true" display="checkboxes">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
109 <option value="CGN">cancer gene neighborhoods</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
110 <option value="CM">cancer modules</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
111 </param>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
112 </when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
113
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
114 <when value="C5">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
115 <param type="select" name="subcategory" label="Sub Category" multiple="true" display="checkboxes">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
116 <option value="GO:BP">GO biological processes</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
117 <option value="GO:CC">GO cellular components</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
118 <option value="GO:MF">GO molecular functions</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
119 <option value="HPO">Human Phenotype Ontology</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
120 </param>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
121 </when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
122 <when value="C6"></when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
123 <when value="C7"></when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
124 <when value="C8"></when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
125
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
126 </conditional>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
127 <param type="select" name="geneIdType" label="gene ID type" help="Specify gene ID type in pathway. Default is Entrez ID.">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
128 <option value="entrez" selected="true">Entrez</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
129 <option value="symbol">Symbol</option>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
130 </param>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
131 </when>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
132
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
133 </conditional>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
134
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
135 <!--<param type="boolean" name="whetherOutputfile" truevalue="True" false="False" checked="False" label="Output GMT file" />-->
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
136
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
137 </inputs>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
138
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
139 <outputs>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
140 <!--<data name="outputGMTFile" format="gmt" />-->
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
141 <data name="outputRData" format="rdata" label="GeneSet object from MSigDB/KEGG" />
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
142 </outputs>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
143
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
144 <tests>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
145 <test>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
146 <conditional name="input_args">
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
147 <param name="source" value="KEGG" />
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
148 <param name="organism" value="hsa" />
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
149 </conditional>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
150 <output name="outputRData" file="geneSet.RData"/>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
151 </test>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
152 </tests>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
153
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
154 <help><![CDATA[
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
155
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
156 .. class:: infomark
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
157
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
158 **What it does**
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
159
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
160 This is a tool built to get a 'geneSetCollection' R object from the MSigDB or KEGG database.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
161
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
162 If the gene sets source is KEGG_, it will only receive a KEGG organism code and output an Rdata file which has a `geneSet` object containing all KEGG pathways with their Entrez gene ID.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
163
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
164 If the gene sets source is MSigDB_, you must assign specific species and categories to define the Gene Set collection. Again, the output is an Rdata file which has a `geneSet` object.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
165
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
166 -----
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
167
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
168 **More Information**
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
169
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
170 **MSigDB Gene Set Colletions**
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
171
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
172 The MSigDB_ gene sets are divided into 9 major collections:
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
173
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
174 * **H: hallmark gene sets** are coherently expressed signatures derived by aggregating many MSigDB gene sets to represent well-defined biological states or processes.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
175 * **C1: positional gene sets** for each human chromosome and cytogenetic band.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
176 * **C2: curated gene sets** are from online pathway databases, publications in PubMed, and knowledge of domain experts.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
177 * **C3: motif gene sets** are based on conserved cis-regulatory motifs from a comparative analysis of the human, mouse, rat, and dog genomes.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
178 * **C4: computational gene sets** are defined by mining large collections of cancer-oriented microarray data.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
179 * **C5: GO gene sets** consist of genes annotated by the same GO terms.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
180 * **C6: oncogenic gene sets** are defined directly from microarray gene expression data from cancer gene perturbations.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
181 * **C7: immunologic gene sets** are defined directly from microarray gene expression data from immunologic studies.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
182 * **C8: cell type signature gene sets** curated from cluster markers identified in single-cell sequencing studies of human tissue.
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
183
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
184 .. _MSigDB: http://software.broadinstitute.org/gsea/msigdb
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
185 .. _KEGG: http://www.genome.jp/kegg/
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
186 ]]></help>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
187
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
188 <citations>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
189 <citation type="bibtex">@ARTICLE{Kim07aninterior-point,
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
190 author = {Xiaowei Huang and Songqing Mei and Antonio Mora},
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
191 title = {Galaxy-GSA –A suite of tools for advanced gene set analysis in Galaxy},
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
192 journal = {Bioinformatics},
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
193 year = {2021},
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
194 volume = {8},
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
195 pages = {1-3}
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
196 }</citation>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
197 </citations>
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
198
0c0d33699925 Uploaded
mora-lab
parents:
diff changeset
199 </tool>