annotate checkSnpEffCandidates.xml @ 9:f20585ccbf05 draft default tip

Uploaded
author gregory-minevich
date Mon, 08 Oct 2012 16:14:46 -0400
parents f5a8d626a329
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
1 <tool id="check_snpeff_candidates" name="CloudMap: Check snpEff Candidates">
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
2 <description>Marks up a snpEff output file with matches to a gene candidate list.</description>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
3 <command interpreter="python">checkSnpEffCandidates.py -s "$snpeff_file" -c "$candidate_list" -o "$output"</command>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
4 <inputs>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
5 <param name="snpeff_file" type="data" format="tabular" label="SnpEff File" help="tabular output file from snpEff"/>
f5a8d626a329 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"/>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
7 </inputs>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
8 <outputs>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
9 <data format="tabular" name="output" />
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
10 </outputs>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
11 <requirements>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
12 <requirement type="python-module">sys</requirement>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
13 <requirement type="python-module">optparse</requirement>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
14 <requirement type="python-module">csv</requirement>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
15 </requirements>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
16 <tests>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
17 <param name="snpeff_file" value="" />
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
18 <param name="candidate_list" value="" />
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
19 </tests>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
20 <help>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
21
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
22 **What it does:**
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
23
f5a8d626a329 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.
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
25
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
26 For a description of the snpEff variant annotation and effect prediction tool:
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
27
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
28 http://snpeff.sourceforge.net
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
29
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
30 ------
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
31
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
32 **Input:**
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
33
f5a8d626a329 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.
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
35
f5a8d626a329 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:
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
37
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
38 http://usegalaxy.org/cloudmap
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
39
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
40
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
41 ------
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
42
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
43 **Citation:**
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
44
f5a8d626a329 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 S. Park, Daniel Blankenberg, Richard J. Poole, and Oliver Hobert. CloudMap: A Cloud-based Pipeline for Analysis of Mutant Genome Sequences. (Genetics 2012 In Press)`__
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
46
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
47 .. __: http://biochemistry.hs.columbia.edu/labs/hobert/literature.html
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
48
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
49 Correspondence to gm2123@columbia.edu (G.M.) or or38@columbia.edu (O.H.)
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
50 </help>
f5a8d626a329 Uploaded
gregory-minevich
parents:
diff changeset
51 </tool>