annotate pileup_interval.xml @ 4:9c1c0b947e46 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/pileup_interval commit 8b2095c59ecc2e94c58a42e2e04dbcecdc823dbf"
author devteam
date Fri, 15 Jan 2021 11:38:56 +0000
parents ef11139d4545
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
9c1c0b947e46 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/pileup_interval commit 8b2095c59ecc2e94c58a42e2e04dbcecdc823dbf"
devteam
parents: 3
diff changeset
1 <tool id="pileup_interval" name="Pileup-to-Interval" version="1.0.3">
9c1c0b947e46 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/pileup_interval commit 8b2095c59ecc2e94c58a42e2e04dbcecdc823dbf"
devteam
parents: 3
diff changeset
2 <requirements>
9c1c0b947e46 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/pileup_interval commit 8b2095c59ecc2e94c58a42e2e04dbcecdc823dbf"
devteam
parents: 3
diff changeset
3 <requirement type="package" version="0.7.1">bx-python</requirement>
9c1c0b947e46 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/pileup_interval commit 8b2095c59ecc2e94c58a42e2e04dbcecdc823dbf"
devteam
parents: 3
diff changeset
4 </requirements>
0
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
5 <description>condenses pileup format into ranges of bases</description>
4
9c1c0b947e46 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/pileup_interval commit 8b2095c59ecc2e94c58a42e2e04dbcecdc823dbf"
devteam
parents: 3
diff changeset
6 <command>
9c1c0b947e46 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/pileup_interval commit 8b2095c59ecc2e94c58a42e2e04dbcecdc823dbf"
devteam
parents: 3
diff changeset
7 python '$__tool_directory__/pileup_interval.py'
0
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
8 --input=$input
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
9 --output=$output
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
10 --coverage=$coverage
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
11 --format=$format_type.format
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
12 #if $format_type.format == "ten":
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
13 --base=$format_type.which_base
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
14 --seq_column="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
15 --loc_column="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
16 --base_column="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
17 --cvrg_column="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
18 #elif $format_type.format == "manual":
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
19 --base="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
20 --seq_column=$format_type.seq_column
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
21 --loc_column=$format_type.loc_column
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
22 --base_column=$format_type.base_column
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
23 --cvrg_column=$format_type.cvrg_column
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
24 #else:
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
25 --base="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
26 --seq_column="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
27 --loc_column="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
28 --base_column="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
29 --cvrg_column="None"
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
30 #end if
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
31 </command>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
32 <inputs>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
33 <param name="input" type="data" format="tabular" label="Choose a pileup file to condense:" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
34 <conditional name="format_type">
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
35 <param name="format" type="select" label="which contains:" help="See &quot;Types of pileup datasets&quot; below for examples">
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
36 <option value="six" selected="true">Pileup with six columns (simple)</option>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
37 <option value="ten">Pileup with ten columns (with consensus)</option>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
38 <option value="manual">Set columns manually</option>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
39 </param>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
40 <when value="six" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
41 <when value="ten">
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
42 <param name="which_base" type="select" label="Which base do you want to concatenate">
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
43 <option value="first" selected="true">Reference base (first)</option>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
44 <option value="second">Consensus base (second)</option>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
45 </param>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
46 </when>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
47 <when value="manual">
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
48 <param name="seq_column" label="Select column with sequence name" type="data_column" numerical="false" data_ref="input" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
49 <param name="loc_column" label="Select column with base location" type="data_column" numerical="false" data_ref="input" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
50 <param name="base_column" label="Select column with base to concatenate" type="data_column" numerical="false" data_ref="input" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
51 <param name="cvrg_column" label="Select column with coverage" type="data_column" numerical="true" data_ref="input" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
52 </when>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
53 </conditional>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
54 <param name="coverage" type="integer" value="3" label="Do not report bases with coverage less than:" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
55 </inputs>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
56 <outputs>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
57 <data format="tabular" name="output" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
58 </outputs>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
59 <tests>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
60 <test>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
61 <param name="input" value="pileup_interval_in1.tabular" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
62 <param name="format" value="six" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
63 <param name="coverage" value="3" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
64 <output name="output" file="pileup_interval_out1.tabular" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
65 </test>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
66 <test>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
67 <param name="input" value="pileup_interval_in2.tabular" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
68 <param name="format" value="ten" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
69 <param name="which_base" value="first" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
70 <param name="coverage" value="3" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
71 <output name="output" file="pileup_interval_out2.tabular" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
72 </test>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
73 <test>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
74 <param name="input" value="pileup_interval_in2.tabular" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
75 <param name="format" value="manual" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
76 <param name="seq_column" value="1" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
77 <param name="loc_column" value="2" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
78 <param name="base_column" value="3" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
79 <param name="cvrg_column" value="8" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
80 <param name="coverage" value="3" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
81 <output name="output" file="pileup_interval_out2.tabular" />
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
82 </test>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
83 </tests>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
84 <help>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
85
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
86 **What is does**
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
87
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
88 Reduces the size of a results set by taking a pileup file and producing a condensed version showing consecutive sequences of bases meeting coverage criteria. The tool works on six and ten column pileup formats produced with *samtools pileup* command. You also can specify columns for the input file manually. The tool assumes that the pileup dataset was produced by *samtools pileup* command (although you can override this by setting column assignments manually).
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
89
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
90 --------
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
91
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
92 **Types of pileup datasets**
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
93
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
94 The description of pileup format below is largely based on information that can be found on SAMTools_ documentation page. The 6- and 10-column variants are described below.
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
95
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
96 .. _SAMTools: http://samtools.sourceforge.net/pileup.shtml
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
97
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
98 **Six column pileup**::
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
99
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
100 1 2 3 4 5 6
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
101 ---------------------------------
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
102 chrM 412 A 2 ., II
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
103 chrM 413 G 4 ..t, IIIH
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
104 chrM 414 C 4 ...a III2
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
105 chrM 415 C 4 TTTt III7
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
106
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
107 where::
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
108
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
109 Column Definition
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
110 ------ ----------------------------
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
111 1 Chromosome
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
112 2 Position (1-based)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
113 3 Reference base at that position
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
114 4 Coverage (# reads aligning over that position)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
115 5 Bases within reads where (see Galaxy wiki for more info)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
116 6 Quality values (phred33 scale, see Galaxy wiki for more)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
117
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
118 **Ten column pileup**
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
119
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
120 The `ten-column`__ pileup incorporates additional consensus information generated with *-c* option of *samtools pileup* command::
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
121
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
122
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
123 1 2 3 4 5 6 7 8 9 10
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
124 ------------------------------------------------
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
125 chrM 412 A A 75 0 25 2 ., II
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
126 chrM 413 G G 72 0 25 4 ..t, IIIH
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
127 chrM 414 C C 75 0 25 4 ...a III2
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
128 chrM 415 C T 75 75 25 4 TTTt III7
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
129
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
130 where::
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
131
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
132 Column Definition
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
133 ------- ----------------------------
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
134 1 Chromosome
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
135 2 Position (1-based)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
136 3 Reference base at that position
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
137 4 Consensus bases
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
138 5 Consensus quality
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
139 6 SNP quality
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
140 7 Maximum mapping quality
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
141 8 Coverage (# reads aligning over that position)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
142 9 Bases within reads where (see Galaxy wiki for more info)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
143 10 Quality values (phred33 scale, see Galaxy wiki for more)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
144
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
145
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
146 .. __: http://samtools.sourceforge.net/cns0.shtml
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
147
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
148 ------
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
149
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
150 **The output format**
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
151
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
152 The output file condenses the information in the pileup file so that consecutive bases are listed together as sequences. The starting and ending points of the sequence range are listed, with the starting value converted to a 0-based value.
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
153
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
154 Given the following input with minimum coverage set to 3::
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
155
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
156 1 2 3 4 5 6
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
157 ---------------------------------
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
158 chr1 112 G 3 ..Ta III6
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
159 chr1 113 T 2 aT.. III5
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
160 chr1 114 A 5 ,,.. IIH2
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
161 chr1 115 C 4 ,., III
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
162 chrM 412 A 2 ., II
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
163 chrM 413 G 4 ..t, IIIH
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
164 chrM 414 C 4 ...a III2
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
165 chrM 415 C 4 TTTt III7
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
166 chrM 490 T 3 a I
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
167
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
168 the following would be the output::
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
169
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
170 1 2 3 4
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
171 -------------------
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
172 chr1 111 112 G
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
173 chr1 113 115 AC
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
174 chrM 412 415 GCC
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
175 chrM 489 490 T
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
176
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
177 where::
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
178
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
179 Column Definition
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
180 ------- ----------------------------
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
181 1 Chromosome
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
182 2 Starting position (0-based)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
183 3 Ending position (1-based)
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
184 4 Sequence of bases
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
185
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
186 </help>
a110f9d6ae24 Uploaded tool tarball.
devteam
parents:
diff changeset
187 </tool>