annotate trams.xml @ 5:b6786c2247b1 draft

Uploaded
author rreumerman
date Fri, 05 Apr 2013 05:05:30 -0400
parents bd5692103d5b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
1 <tool id="trams" name="TRAMS">
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
2
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
3 <description>Tool for Rapid Annotation of Microbial SNPs</description>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
4
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
5 <command interpreter="python">trams.py $input1 $input2 $ref_format $annot $overl $sum</command>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
6
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
7 <inputs>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
8
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
9 <param name="input1" type="data" format="tabular" label="SNP table" />
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
10
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
11 <param name="input2" type="data" format="txt" label="Reference genome" help="Reference genome file, should be genbank or embl file." />
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
12
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
13 <param name="ref_format" type="select">
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
14
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
15 <label>Reference file type</label>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
16
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
17 <option value="gb">Genbank</option>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
18
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
19 <option value="embl">EMBL</option>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
20
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
21 </param>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
22
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
23 </inputs>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
24
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
25 <outputs>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
26
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
27 <data name="annot" format="tabular" label="${tool.name} on ${on_string}: SNP annotation file" />
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
28
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
29 <data name="overl" format="tabular" label="${tool.name} on ${on_string}: Overlap file" />
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
30
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
31 <data name="sum" format="txt" label="${tool.name} on ${on_string}: Summary file" />
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
32
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
33 </outputs>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
34
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
35 <help>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
36
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
37
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
38
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
39 **What it does**
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
40
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
41
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
42
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
43 This tool annotates SNPs from a SNP table and a genbank or embl reference file.
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
44
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
45
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
46
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
47 **Input**
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
48
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
49
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
50
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
51 The SNP table has to be tabular (tab-delimited), with headers on the first line (strain names/numbers). Consecutive lines should contain SNP position in the first column, reference base in the second and SNP bases in consecutive columns. Any number of strains can be compared to the reference.
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
52
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
53
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
54
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
55 ======== ==== ======= =======
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
56
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
57 Position Ref. Strain1 Strain2
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
58
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
59 102 a g c
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
60
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
61 158 c c t
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
62
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
63 200 t a a
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
64
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
65 etc.. .. .. ..
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
66
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
67 ======== ==== ======= =======
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
68
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
69
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
70
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
71
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
72 **Output**
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
73
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
74
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
75
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
76 TRAMS produces three output files. The **SNP annotation file** contains an annotation of each SNP in the input table, giving gene function and the type of SNP (synonymous, nonsynonymous, etc). The **Overlap file** reports on SNPs or ranges of SNPs that are located in multiple features (as defined in the reference genome file). These SNPs can be found in the annotation file once for each feature. The **Summary file** gives an overview of the number of SNPs in each strain and a breakdown of how the SNPs are spread over different types.
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
77
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
78 </help>
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
79
bd5692103d5b Uploaded
rreumerman
parents:
diff changeset
80 </tool>