annotate getalleleseq.xml @ 9:5a89151b5e82 draft default tip

Deleted selected files
author boris
date Tue, 18 Mar 2014 12:26:05 -0400
parents 698ede7baba9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
698ede7baba9 Uploaded
boris
parents:
diff changeset
1 <tool id="getalleleseq" name="FASTA from allele counts" version="0.0.1" force_history_refresh="True">
698ede7baba9 Uploaded
boris
parents:
diff changeset
2 <description>Generate major and minor allele sequences from alleles table</description>
698ede7baba9 Uploaded
boris
parents:
diff changeset
3 <command interpreter="python">getalleleseq.py
698ede7baba9 Uploaded
boris
parents:
diff changeset
4 $alleles
698ede7baba9 Uploaded
boris
parents:
diff changeset
5 -l $seq_length
698ede7baba9 Uploaded
boris
parents:
diff changeset
6 -j $major_seq
698ede7baba9 Uploaded
boris
parents:
diff changeset
7 -p $major_seq.id
698ede7baba9 Uploaded
boris
parents:
diff changeset
8 </command>
698ede7baba9 Uploaded
boris
parents:
diff changeset
9 <inputs>
698ede7baba9 Uploaded
boris
parents:
diff changeset
10 <param format="tabular" name="alleles" type="data" label="Table containing major and minor alleles base per position" help="must be tabular and follow the Variant Annotator tool output format"/>
698ede7baba9 Uploaded
boris
parents:
diff changeset
11 <param name="seq_length" type="integer" value="16569" label="Background sequence length" help="e.g. 16569 for mitochondrial variants"/>
698ede7baba9 Uploaded
boris
parents:
diff changeset
12 </inputs>
698ede7baba9 Uploaded
boris
parents:
diff changeset
13 <outputs>
698ede7baba9 Uploaded
boris
parents:
diff changeset
14 <data format="fasta" name="major_seq"/>
698ede7baba9 Uploaded
boris
parents:
diff changeset
15 </outputs>
698ede7baba9 Uploaded
boris
parents:
diff changeset
16 <tests>
698ede7baba9 Uploaded
boris
parents:
diff changeset
17 <test>
698ede7baba9 Uploaded
boris
parents:
diff changeset
18 <param name="alleles" value="test-table-getalleleseq.tab"/>
698ede7baba9 Uploaded
boris
parents:
diff changeset
19 <param name="seq_length" value="16569"/>
698ede7baba9 Uploaded
boris
parents:
diff changeset
20 <output name="major_seq" file="test-major-allele-out-getalleleseq.fa"/>
698ede7baba9 Uploaded
boris
parents:
diff changeset
21 </test>
698ede7baba9 Uploaded
boris
parents:
diff changeset
22 </tests>
698ede7baba9 Uploaded
boris
parents:
diff changeset
23
698ede7baba9 Uploaded
boris
parents:
diff changeset
24 <help>
698ede7baba9 Uploaded
boris
parents:
diff changeset
25
698ede7baba9 Uploaded
boris
parents:
diff changeset
26
698ede7baba9 Uploaded
boris
parents:
diff changeset
27 The major allele sequence of a sample is simply the sequence consisting of the most frequent nucleotide per position.
698ede7baba9 Uploaded
boris
parents:
diff changeset
28 Replacing the major allele for the second most frequent allele at diploid positions generates the minor allele sequence.
698ede7baba9 Uploaded
boris
parents:
diff changeset
29
698ede7baba9 Uploaded
boris
parents:
diff changeset
30 -----
698ede7baba9 Uploaded
boris
parents:
diff changeset
31
698ede7baba9 Uploaded
boris
parents:
diff changeset
32 .. class:: infomark
698ede7baba9 Uploaded
boris
parents:
diff changeset
33
698ede7baba9 Uploaded
boris
parents:
diff changeset
34 **What it does**
698ede7baba9 Uploaded
boris
parents:
diff changeset
35
698ede7baba9 Uploaded
boris
parents:
diff changeset
36 It takes the table generated from the Variant Annotator tool to derive a major and minor allele sequence per sample.
698ede7baba9 Uploaded
boris
parents:
diff changeset
37 Since all sequences share the same length all the major allele sequences are included into a single file (with proper headers per sample)
698ede7baba9 Uploaded
boris
parents:
diff changeset
38 to create a multiple sequence alignment in FASTA format that can be used for downstream phylogenetic analyses.
698ede7baba9 Uploaded
boris
parents:
diff changeset
39 In contrast, the minor allele sequences are informed as single FASTA files per sample to ease their downstream manipulation.
698ede7baba9 Uploaded
boris
parents:
diff changeset
40
698ede7baba9 Uploaded
boris
parents:
diff changeset
41 -----
698ede7baba9 Uploaded
boris
parents:
diff changeset
42
698ede7baba9 Uploaded
boris
parents:
diff changeset
43 .. class:: warningmark
698ede7baba9 Uploaded
boris
parents:
diff changeset
44
698ede7baba9 Uploaded
boris
parents:
diff changeset
45 **Note**
698ede7baba9 Uploaded
boris
parents:
diff changeset
46
698ede7baba9 Uploaded
boris
parents:
diff changeset
47 Please, follow the format described below for the input file:
698ede7baba9 Uploaded
boris
parents:
diff changeset
48
698ede7baba9 Uploaded
boris
parents:
diff changeset
49 -----
698ede7baba9 Uploaded
boris
parents:
diff changeset
50
698ede7baba9 Uploaded
boris
parents:
diff changeset
51 .. class:: infomark
698ede7baba9 Uploaded
boris
parents:
diff changeset
52
698ede7baba9 Uploaded
boris
parents:
diff changeset
53 **Formats**
698ede7baba9 Uploaded
boris
parents:
diff changeset
54
698ede7baba9 Uploaded
boris
parents:
diff changeset
55 **Variant Annotator tool output format**
698ede7baba9 Uploaded
boris
parents:
diff changeset
56
698ede7baba9 Uploaded
boris
parents:
diff changeset
57 Columns::
698ede7baba9 Uploaded
boris
parents:
diff changeset
58
698ede7baba9 Uploaded
boris
parents:
diff changeset
59 1. sample id
698ede7baba9 Uploaded
boris
parents:
diff changeset
60 2. chromosome
698ede7baba9 Uploaded
boris
parents:
diff changeset
61 3. position
698ede7baba9 Uploaded
boris
parents:
diff changeset
62 4 counts for A's
698ede7baba9 Uploaded
boris
parents:
diff changeset
63 5. counts for C's
698ede7baba9 Uploaded
boris
parents:
diff changeset
64 6. counts for G's
698ede7baba9 Uploaded
boris
parents:
diff changeset
65 7. counts for T's
698ede7baba9 Uploaded
boris
parents:
diff changeset
66 8. Coverage
698ede7baba9 Uploaded
boris
parents:
diff changeset
67 9. Number of alleles passing frequency threshold
698ede7baba9 Uploaded
boris
parents:
diff changeset
68 10. Major allele
698ede7baba9 Uploaded
boris
parents:
diff changeset
69 11. Minor allele
698ede7baba9 Uploaded
boris
parents:
diff changeset
70 12. Minor allele frequency in position
698ede7baba9 Uploaded
boris
parents:
diff changeset
71
698ede7baba9 Uploaded
boris
parents:
diff changeset
72
698ede7baba9 Uploaded
boris
parents:
diff changeset
73 **FASTA multiple alignment**
698ede7baba9 Uploaded
boris
parents:
diff changeset
74
698ede7baba9 Uploaded
boris
parents:
diff changeset
75 See http://www.bioperl.org/wiki/FASTA_multiple_alignment_format
698ede7baba9 Uploaded
boris
parents:
diff changeset
76
698ede7baba9 Uploaded
boris
parents:
diff changeset
77 -----
698ede7baba9 Uploaded
boris
parents:
diff changeset
78
698ede7baba9 Uploaded
boris
parents:
diff changeset
79 **Example**
698ede7baba9 Uploaded
boris
parents:
diff changeset
80
698ede7baba9 Uploaded
boris
parents:
diff changeset
81 - For the following dataset::
698ede7baba9 Uploaded
boris
parents:
diff changeset
82
698ede7baba9 Uploaded
boris
parents:
diff changeset
83 S9 chrM 3 3 0 2 214 219 0 T A 0.013698630137
698ede7baba9 Uploaded
boris
parents:
diff changeset
84 S9 chrM 4 3 249 3 0 255 0 C N 0.0
698ede7baba9 Uploaded
boris
parents:
diff changeset
85 S9 chrM 5 245 1 1 0 247 1 A N 0.0
698ede7baba9 Uploaded
boris
parents:
diff changeset
86 S11 chrM 6 0 292 0 0 292 1 C . 0.0
698ede7baba9 Uploaded
boris
parents:
diff changeset
87 S7 chrM 6 0 254 0 0 254 1 C . 0.0
698ede7baba9 Uploaded
boris
parents:
diff changeset
88 S9 chrM 6 2 306 2 0 310 0 C N 0.0
698ede7baba9 Uploaded
boris
parents:
diff changeset
89 S11 chrM 7 281 0 3 0 284 0 A G 0.0105633802817
698ede7baba9 Uploaded
boris
parents:
diff changeset
90 S7 chrM 7 249 0 2 0 251 1 A G 0.00796812749004
698ede7baba9 Uploaded
boris
parents:
diff changeset
91 etc. for all covered positions per sample...
698ede7baba9 Uploaded
boris
parents:
diff changeset
92
698ede7baba9 Uploaded
boris
parents:
diff changeset
93 - Running this tool with background sequence length 16569 will produce 4 files::
698ede7baba9 Uploaded
boris
parents:
diff changeset
94
698ede7baba9 Uploaded
boris
parents:
diff changeset
95 1. Multiple alignment FASTA file containing the major allele sequences of samples S7, S9 and S11
698ede7baba9 Uploaded
boris
parents:
diff changeset
96 2. minor allele sequence of sample S7
698ede7baba9 Uploaded
boris
parents:
diff changeset
97 3. minor allele sequence of sample S9
698ede7baba9 Uploaded
boris
parents:
diff changeset
98 4. minor allele sequence of sample S11
698ede7baba9 Uploaded
boris
parents:
diff changeset
99
698ede7baba9 Uploaded
boris
parents:
diff changeset
100 -----
698ede7baba9 Uploaded
boris
parents:
diff changeset
101
698ede7baba9 Uploaded
boris
parents:
diff changeset
102 **Citation**
698ede7baba9 Uploaded
boris
parents:
diff changeset
103
698ede7baba9 Uploaded
boris
parents:
diff changeset
104 If you use this tool, please cite Dickins B, Rebolledo-Jaramillo B, et al (2014). *Acccepted in Biotechniques*
698ede7baba9 Uploaded
boris
parents:
diff changeset
105 (boris-at-bx.psu.edu)
698ede7baba9 Uploaded
boris
parents:
diff changeset
106
698ede7baba9 Uploaded
boris
parents:
diff changeset
107 </help>
698ede7baba9 Uploaded
boris
parents:
diff changeset
108 </tool>