Mercurial > repos > jjohnson > snpsift_genesets

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/snpSift_geneSets.xml	Wed Dec 09 14:16:44 2015 -0500
@@ -0,0 +1,70 @@
+<tool id="snpSift_geneSets" name="SnpSift GeneSets" version="@WRAPPER_VERSION@.0">
+    <description>Annotating GeneSets, such as Gene Ontology, KEGG, Reactome</description>
+    <!--
+        You can change the amount of memory used, just change the -Xmx parameter (e.g. use -Xmx2G for 2Gb of memory)
+    -->
+    <macros>
+        <import>snpSift_macros.xml</import>
+    </macros>
+    <expand macro="requirements" />
+    <expand macro="stdio" />
+    <expand macro="version_command" />
+    <command><![CDATA[
+        java -Xmx2G -jar \$SNPEFF_JAR_PATH/SnpSift.jar geneSets -v
+        #if $db_opts.db_opts_selector == "db"
+          "${db_opts.database.fields.path}"
+        #elif $db_opts.db_opts_selector == "histdb"
+          "$db_opts.histdb"
+        #end if
+        $input 2> $log > $output
+]]>
+    </command>
+    <inputs>
+        <param format="vcf" name="input" type="data" label="Variant input file in VCF format"/>
+        <conditional name="db_opts">
+            <param name="db_opts_selector" type="select" label="Select Annotation database" help="">
+              <option value="db" selected="True">Locally installed database</option>
+              <option value="histdb">database from your history</option>
+            </param>
+            <when value="db">
+                <param name="database" type="select" label="Molecular Signatures Database (MSigDB)">
+                    <options from_data_table="snpeff_msigdb_database" />
+                </param>
+                <param name="histdb" type="hidden" value="" />
+            </when>
+            <when value="histdb">
+                <param name="histdb" type="data" format="txt" label="Molecular Signatures Database (MSigDB)" />
+            </when>
+        </conditional>
+    </inputs>
+    <outputs>
+        <data format="vcf" name="output" label="${tool.name} on ${on_string}: VCF" />
+        <data format="txt" name="log" label="${tool.name} on ${on_string}: log" />
+    </outputs>
+    <tests>
+    </tests>
+    <help><![CDATA[
+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.
+
+.. _SnpSift GeneSets: http://snpeff.sourceforge.net/SnpSift.html#geneSets
+
+.. class:: warningmark
+
+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.
+
+@EXTERNAL_DOCUMENTATION@
+
+@CITATION_SECTION@
+
+For `MSigDB`_, please cite |Subramanian2005|_.
+
+.. _MSigDB: http://www.broadinstitute.org/gsea/msigdb/
+.. |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
+.. _Subramanian2005: http://www.pnas.org/content/102/43/15545
+
+]]>
+    </help>
+    <expand macro="citations">
+        <citation type="doi">10.1073/pnas.0506580102</citation><!-- MSigDB citation -->
+    </expand>
+</tool>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/snpSift_macros.xml	Wed Dec 09 14:16:44 2015 -0500
@@ -0,0 +1,39 @@
+<macros>
+    <xml name="requirements">
+        <requirements>
+            <requirement type="package" version="4.1">snpEff</requirement>
+        </requirements>
+    </xml>
+  <xml name="stdio">
+    <stdio>
+        <exit_code range=":-1"  level="fatal" description="Error: Cannot open file" />
+        <exit_code range="1:"  level="fatal" description="Error" />
+    </stdio>
+  </xml>
+  <xml name="version_command">
+    <version_command>java -jar $SNPEFF_JAR_PATH/SnpEff.jar -version</version_command>
+  </xml>
+  <token name="@WRAPPER_VERSION@">4.1</token>
+  <token name="@EXTERNAL_DOCUMENTATION@">
+
+For details about this tool, please go to:
+	http://snpeff.sourceforge.net/SnpEff_manual.html
+
+  </token>
+  <token name="@CITATION_SECTION@">------
+
+**Citation**
+
+For the underlying tool, please cite the following two publications:
+
+SnpSift citation:
+"Using Drosophila melanogaster as a model for genotoxic chemical mutational studies with a new program, SnpSift", Cingolani, P., et. al., Frontiers in Genetics, 3:35, 2012.
+
+  </token>
+  <xml name="citations">
+      <citations>
+        <citation type="doi">10.3389/fgene.2012.00035</citation>
+        <yield />
+      </citations>
+  </xml>
+</macros>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tool-data/snpeff_msigdb_database.loc.sample	Wed Dec 09 14:16:44 2015 -0500
@@ -0,0 +1,4 @@
+## Molecular Signatures Database (MSigDB) for SnpEff.
+## You can download MSigDb from http://www.broadinstitute.org/gsea/msigdb
+#msigdb_id	msigdb_name path_to_database
+#msigdb_08_2014 MSigDB 08-2014	/data/msigdb/08_2014/msigdb.gmt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tool_data_table_conf.xml.sample	Wed Dec 09 14:16:44 2015 -0500
@@ -0,0 +1,7 @@
+<tables>
+    <table name="snpeff_msigdb_database" comment_char="#">
+        <columns>value, name, path</columns>
+        <file path="tool-data/snpeff_msigdb_database.loc" />
+    </table>
+</tables>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tool_dependencies.xml	Wed Dec 09 14:16:44 2015 -0500
@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<tool_dependency>
+    <package name="snpEff" version="4.1">
+        <repository changeset_revision="02a5e07a4121" name="package_snpeff_4_1" owner="iuc" toolshed="https://testtoolshed.g2.bx.psu.edu" />
+    </package>
+</tool_dependency>