annotate snpSift_geneSets.xml @ 0:187c66b446ae draft default tip

Uploaded
author jjohnson
date Wed, 09 Dec 2015 14:16:44 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
1 <tool id="snpSift_geneSets" name="SnpSift GeneSets" version="@WRAPPER_VERSION@.0">
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
2 <description>Annotating GeneSets, such as Gene Ontology, KEGG, Reactome</description>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
3 <!--
187c66b446ae Uploaded
jjohnson
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)
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
5 -->
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
6 <macros>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
7 <import>snpSift_macros.xml</import>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
8 </macros>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
9 <expand macro="requirements" />
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
10 <expand macro="stdio" />
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
11 <expand macro="version_command" />
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
12 <command><![CDATA[
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
13 java -Xmx2G -jar \$SNPEFF_JAR_PATH/SnpSift.jar geneSets -v
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
14 #if $db_opts.db_opts_selector == "db"
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
15 "${db_opts.database.fields.path}"
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
16 #elif $db_opts.db_opts_selector == "histdb"
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
17 "$db_opts.histdb"
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
18 #end if
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
19 $input 2> $log > $output
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
20 ]]>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
21 </command>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
22 <inputs>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
23 <param format="vcf" name="input" type="data" label="Variant input file in VCF format"/>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
24 <conditional name="db_opts">
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
25 <param name="db_opts_selector" type="select" label="Select Annotation database" help="">
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
26 <option value="db" selected="True">Locally installed database</option>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
27 <option value="histdb">database from your history</option>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
28 </param>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
29 <when value="db">
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
30 <param name="database" type="select" label="Molecular Signatures Database (MSigDB)">
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
31 <options from_data_table="snpeff_msigdb_database" />
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
32 </param>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
33 <param name="histdb" type="hidden" value="" />
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
34 </when>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
35 <when value="histdb">
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
36 <param name="histdb" type="data" format="txt" label="Molecular Signatures Database (MSigDB)" />
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
37 </when>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
38 </conditional>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
39 </inputs>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
40 <outputs>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
41 <data format="vcf" name="output" label="${tool.name} on ${on_string}: VCF" />
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
42 <data format="txt" name="log" label="${tool.name} on ${on_string}: log" />
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
43 </outputs>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
44 <tests>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
45 </tests>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
46 <help><![CDATA[
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
47 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.
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
48
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
49 .. _SnpSift GeneSets: http://snpeff.sourceforge.net/SnpSift.html#geneSets
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
50
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
51 .. class:: warningmark
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
52
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
53 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.
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
54
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
55 @EXTERNAL_DOCUMENTATION@
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
56
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
57 @CITATION_SECTION@
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
58
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
59 For `MSigDB`_, please cite |Subramanian2005|_.
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
60
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
61 .. _MSigDB: http://www.broadinstitute.org/gsea/msigdb/
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
62 .. |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
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
63 .. _Subramanian2005: http://www.pnas.org/content/102/43/15545
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
64
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
65 ]]>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
66 </help>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
67 <expand macro="citations">
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
68 <citation type="doi">10.1073/pnas.0506580102</citation><!-- MSigDB citation -->
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
69 </expand>
187c66b446ae Uploaded
jjohnson
parents:
diff changeset
70 </tool>