annotate checkSnpEffCandidates.xml @ 6:22c8c4f8d11c draft

Uploaded
author gregory-minevich
date Mon, 25 Jun 2012 16:13:18 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
1 <tool id="check_snpeff_candidates" name="CloudMap: Check snpEff Candidates">
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
2 <description>Marks up a snpEff output file with matches to a gene candidate list.</description>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
3 <command interpreter="python">checkSnpEffCandidates.py -s $snpeff_file -c $candidate_list -o $output</command>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
4 <inputs>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
5 <param name="snpeff_file" type="data" format="tabular" label="SnpEff File" help="tabular output file from snpEff"/>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
6 <param name="candidate_list" type="data" format="tabular" label="Candidate List" help="2 column list consisting of candidate genes and a description"/>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
7 </inputs>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
8 <outputs>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
9 <data format="tabular" name="output" />
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
10 </outputs>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
11 <requirements>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
12 <requirement type="python-module">sys</requirement>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
13 <requirement type="python-module">optparse</requirement>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
14 <requirement type="python-module">csv</requirement>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
15 </requirements>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
16 <tests>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
17 <param name="snpeff_file" value="" />
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
18 <param name="candidate_list" value="" />
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
19 </tests>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
20 <help>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
21
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
22 **What it does:**
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
23
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
24 Indicates on a SnpEff output file which genes are found in a candidate list by comparing Gene IDs.
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
25
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
26 For a description of the snpEff variant annotation and effect prediction tool:
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
27
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
28 http://snpeff.sourceforge.net
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
29
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
30 ------
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
31
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
32 **Input:**
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
33
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
34 The candidate list should be in a tabular format with two columns: Gene ID and Gene Description (e.g. C55B7.12 and transcription_factor). The file should contain no headers.
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
35
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
36 Useful candidate lists (e.g. transcription factors, genes expressed in neurons, transgene silencers, chromatin factors) are available on the CloudMap Galaxy page:
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
37
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
38 https://test.g2.bx.psu.edu/u/gal40/p/cloudmap
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
39
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
40
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
41 ------
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
42
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
43 **Citation:**
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
44
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
45 This tool is part of the CloudMap pipeline for analysis of mutant genome sequences. For further details, please see `Gregory Minevich, Danny Park, Richard J. Poole, Daniel Blankenberg, Anton Nekrutenko, and Oliver Hobert. CloudMap: A Cloud-based Pipeline for Analysis of Mutant Genome Sequences. (2012 In Preparation)`__
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
46
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
47 .. __: http://biochemistry.hs.columbia.edu/labs/hobert/literature.html
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
48
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
49 Correspondence to gm2123@columbia.edu (G.M.) or or38@columbia.edu (O.H.)
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
50 </help>
22c8c4f8d11c Uploaded
gregory-minevich
parents:
diff changeset
51 </tool>