annotate snpSift_geneSets.xml @ 2:9ba6e2c298ab draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 44b3b8a31f9f912a3b754aef1d467a90a4ed3504
author iuc
date Mon, 19 Sep 2016 14:43:55 -0400
parents 0af41de4eda1
children 847db7b39bdc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
1 <tool id="snpSift_geneSets" name="SnpSift GeneSets" version="@WRAPPER_VERSION@.0">
0
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
2 <description>Annotating GeneSets, such as Gene Ontology, KEGG, Reactome</description>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
3 <!--
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
4 You can change the amount of memory used, just change the -Xmx parameter (e.g. use -Xmx2G for 2Gb of memory)
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
5 -->
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
6 <macros>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
7 <import>snpSift_macros.xml</import>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
8 </macros>
1
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
9 <expand macro="requirements" />
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
10 <expand macro="stdio" />
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
11 <expand macro="version_command" />
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
12 <command><![CDATA[
2
9ba6e2c298ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 44b3b8a31f9f912a3b754aef1d467a90a4ed3504
iuc
parents: 1
diff changeset
13 @CONDA_SNPEFF_JAR_PATH@ &&
1
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
14 java -Xmx2G -jar "\$SNPEFF_JAR_PATH/SnpSift.jar" geneSets -v
0
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
15 #if $db_opts.db_opts_selector == "db"
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
16 "${db_opts.database.fields.path}"
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
17 #elif $db_opts.db_opts_selector == "histdb"
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
18 "$db_opts.histdb"
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
19 #end if
1
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
20 "$input" 2> "$log" > "$output"
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
21 ]]>
0
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
22 </command>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
23 <inputs>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
24 <param format="vcf" name="input" type="data" label="Variant input file in VCF format"/>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
25 <conditional name="db_opts">
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
26 <param name="db_opts_selector" type="select" label="Select Annotation database" help="">
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
27 <option value="db" selected="True">Locally installed database</option>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
28 <option value="histdb">database from your history</option>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
29 </param>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
30 <when value="db">
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
31 <param name="database" type="select" label="Molecular Signatures Database (MSigDB)">
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
32 <options from_data_table="snpeff_msigdb_database" />
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
33 </param>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
34 <param name="histdb" type="hidden" value="" />
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
35 </when>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
36 <when value="histdb">
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
37 <param name="histdb" type="data" format="txt" label="Molecular Signatures Database (MSigDB)" />
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
38 </when>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
39 </conditional>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
40 </inputs>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
41 <outputs>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
42 <data format="vcf" name="output" label="${tool.name} on ${on_string}: VCF" />
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
43 <data format="txt" name="log" label="${tool.name} on ${on_string}: log" />
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
44 </outputs>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
45 <tests>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
46 </tests>
1
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
47 <help><![CDATA[
0
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
48 This tool uses `SnpSift GeneSets`_ to add annotations from `MSigDB`_, a collection of annotated gene sets from different sources including Gene Ontology (GO), KEGG, Reactome.
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
49
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
50 .. _SnpSift GeneSets: http://snpeff.sourceforge.net/SnpSift.html#geneSets
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
51
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
52 .. class:: warningmark
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
53
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
54 The input VCF file must be annotated using SnpEff before performing GeneSets annotations. This is because the tool must know which gene the variant affects.
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
55
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
56 @EXTERNAL_DOCUMENTATION@
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
57
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
58 @CITATION_SECTION@
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
59
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
60 For `MSigDB`_, please cite |Subramanian2005|_.
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
61
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
62 .. _MSigDB: http://www.broadinstitute.org/gsea/msigdb/
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
63 .. |Subramanian2005| replace:: Subramanian, A., *et al.* (2005) Gene set enrichment analysis: A knowledge-based approach for interpreting genome-wide expression profiles. *Proc. Natl. Acad. Sci. U.S.A.* 102(43), 15545-15550
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
64 .. _Subramanian2005: http://www.pnas.org/content/102/43/15545
1
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
65
0af41de4eda1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
66 ]]>
0
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
67 </help>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
68 <expand macro="citations">
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
69 <citation type="doi">10.1073/pnas.0506580102</citation><!-- MSigDB citation -->
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
70 </expand>
9e6fa49c1077 Uploaded
iuc
parents:
diff changeset
71 </tool>