annotate samtool_filter2.xml @ 2:886b73f04847 draft

planemo upload commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
author devteam
date Fri, 09 Oct 2015 17:24:03 -0400
parents 94d5786febc4
children c31a37f6d48a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="samtool_filter2" name="Filter SAM or BAM, output SAM or BAM" version="1.1.1">
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
2 <description>files on FLAG MAPQ RG LN or by region</description>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="0.1.18">samtools</requirement>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
5 </requirements>
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
6 <stdio>
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
7 <exit_code range="1:" />
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
8 </stdio>
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
9 <command>
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
10 <![CDATA[
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
11 ##set up input files, regions requires input.bam and input.bai
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
12 #if isinstance($input1.datatype, $__app__.datatypes_registry.get_datatype_by_extension('bam').__class__):
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
13 #set $input = 'input.bam'
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
14 ln -s "$input1" $input &&
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
15 ln -s "$input1.metadata.bam_index" input.bai &&
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
16 #elif isinstance($input1.datatype, $__app__.datatypes_registry.get_datatype_by_extension('sam').__class__):
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
17 #set $input = 'input.sam'
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
18 ln -s "$input1" $input &&
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
19 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
20 samtools view -o "$output1" $header
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
21
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
22 #if $input1.datatype.file_ext == 'sam':
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
23 -S
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
24 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
25
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
26 #if $outputtype.__str__ == "bam":
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
27 -b
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
28 #end if
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
29
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
30 #if $mapq.__str__ != '':
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
31 -q $mapq
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
32 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
33 #if $flag.filter.__str__ == 'yes':
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
34 #if $flag.reqBits.__str__ != 'None':
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
35 #set $reqs = $flag.reqBits.__str__.split(',')
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
36 #set $reqFlag = 0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
37 #for $xn in $reqs:
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
38 #set $reqFlag += int(xn,16)
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
39 #end for
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
40 -f $hex($reqFlag)
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
41 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
42 #if $flag.skipBits.__str__ != 'None':
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
43 #set $skips = $flag.skipBits.__str__.split(',')
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
44 #set $skipFlag = 0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
45 #for $xn in $skips:
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
46 #set $skipFlag += int(xn,16)
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
47 #end for
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
48 -F $hex($skipFlag)
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
49 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
50 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
51 #if $read_group.__str__.strip() != '':
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
52 -r $read_group
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
53 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
54 #if $library.__str__.strip() != '':
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
55 -l $library
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
56 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
57 #if $bed_file.__str__ != "None" and len($bed_file.__str__) > 0:
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
58 -L "$bed_file"
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
59 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
60 $input
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
61 #if $regions.__str__.strip() != '' and $input1.datatype.file_ext == 'bam':
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
62 $regions.__str__.strip()
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
63 #end if
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
64 ## need to redirect stderr message so galaxy does not think this failed
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
65 2>&1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
66 ]]>
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
67 </command>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
68 <inputs>
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
69 <param name="input1" type="data" format="sam,bam" label="SAM or BAM file to filter" />
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
70 <param name="header" type="select" label="Header in output">
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
71 <option value="-h">Include Header</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
72 <option value="">Exclude Header</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
73 <option value="-H">Only the Header</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
74 </param>
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
75 <param name="mapq" type="integer" value="" optional="true" label="Minimum MAPQ quality score" help="(-q)">
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
76 <validator type="in_range" message="The MAPQ quality score can't be negative" min="0"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
77 </param>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
78 <conditional name="flag">
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
79 <param name="filter" type="select" label="Filter on bitwise flag">
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
80 <option value="no">no</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
81 <option value="yes">yes</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
82 </param>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
83 <when value="no"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
84 <when value="yes">
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
85 <param name="reqBits" type="select" multiple="true" display="checkboxes" label="Only output alignments with all of these flag bits set" help="(-f)">
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
86 <option value="0x0001">Read is paired</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
87 <option value="0x0002">Read is mapped in a proper pair</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
88 <option value="0x0004">The read is unmapped</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
89 <option value="0x0008">The mate is unmapped</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
90 <option value="0x0010">Read strand</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
91 <option value="0x0020">Mate strand</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
92 <option value="0x0040">Read is the first in a pair</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
93 <option value="0x0080">Read is the second in a pair</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
94 <option value="0x0100">The alignment or this read is not primary</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
95 <option value="0x0200">The read fails platform/vendor quality checks</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
96 <option value="0x0400">The read is a PCR or optical duplicate</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
97 </param>
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
98 <param name="skipBits" type="select" multiple="true" display="checkboxes" label="Skip alignments with any of these flag bits set" help="(-F)">
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
99 <option value="0x0001">Read is paired</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
100 <option value="0x0002">Read is mapped in a proper pair</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
101 <option value="0x0004">The read is unmapped</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
102 <option value="0x0008">The mate is unmapped</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
103 <option value="0x0010">Read strand</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
104 <option value="0x0020">Mate strand</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
105 <option value="0x0040">Read is the first in a pair</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
106 <option value="0x0080">Read is the second in a pair</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
107 <option value="0x0100">The alignment or this read is not primary</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
108 <option value="0x0200">The read fails platform/vendor quality checks</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
109 <option value="0x0400">The read is a PCR or optical duplicate</option>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
110 </param>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
111 </when>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
112 </conditional>
2
886b73f04847 planemo upload commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents: 1
diff changeset
113 <param name="library" type="text" value="" label="Select alignments from Library"
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
114 help="(-l) Requires headers in the input SAM or BAM, otherwise no alignments will be output"/>
2
886b73f04847 planemo upload commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents: 1
diff changeset
115 <param name="read_group" type="text" value="" label="Select alignments from Read Group"
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
116 help="(-r) Requires headers in the input SAM or BAM, otherwise no alignments will be output"/>
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
117 <param name="bed_file" type="data" format="bed" optional="true" label="Output alignments overlapping the regions in the BED FILE" help="(-L)"/>
2
886b73f04847 planemo upload commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents: 1
diff changeset
118 <param name="regions" type="text" value="" label="Select regions (only used when the input is in BAM format)"
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
119 help="region should be presented in one of the following formats: `chr1', `chr2:1,000' and `chr3:1000-2,000'"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
120 <param name="outputtype" type="select" label="Select the output format">
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
121 <option value="bam">BAM (-b)</option>
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
122 <option value="sam">SAM</option>
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
123 </param>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
124 </inputs>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
125 <outputs>
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
126 <data name="output1" format="sam" label="${tool.name} on ${on_string}: ${outputtype}">
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
127 <change_format>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
128 <when input="outputtype" value="bam" format="bam" />
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
129 </change_format>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
130 </data>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
131 </outputs>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
132 <tests>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
133 <test>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
134 <param name="input1" value="bam_to_sam_in2.sam" ftype="sam" />
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
135 <param name="header" value=""/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
136 <param name="filter" value="yes"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
137 <param name="reqBits" value="0x0080"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
138 <param name="outputtype" value="sam"/>
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
139 <output name="output1">
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
140 <assert_contents>
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
141 <has_text text="141" />
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
142 <not_has_text text="77" />
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
143 </assert_contents>
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
144 </output>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
145 </test>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
146 <test>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
147 <param name="input1" value="bam_to_sam_in2.sam" ftype="sam" />
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
148 <param name="header" value=""/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
149 <param name="filter" value="no"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
150 <param name="read_group" value="rg1"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
151 <param name="outputtype" value="sam"/>
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
152 <output name="output1">
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
153 <assert_contents>
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
154 <has_text text="rg1" />
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
155 <not_has_text text="rg2" />
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
156 </assert_contents>
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
157 </output>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
158 </test>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
159 <test>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
160 <param name="input1" value="bam_to_sam_in1.sam" ftype="sam" />
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
161 <param name="header" value=""/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
162 <param name="filter" value="yes"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
163 <param name="skipBits" value="0x0008"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
164 <param name="mapq" value="250"/>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
165 <param name="outputtype" value="sam"/>
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
166 <output name="output1">
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
167 <assert_contents>
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
168 <has_text text="both_reads_align_clip_marked" />
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
169 <not_has_text text="both_reads_present_only_first_aligns" />
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
170 </assert_contents>
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
171 </output>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
172 </test>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
173 </tests>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
174 <help>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
175 **What it does**
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
176
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
177 This tool uses the samtools view command in SAMtools_ toolkit to filter a SAM or BAM file on the MAPQ (mapping quality), FLAG bits, Read Group, Library, or region.
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
178
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
179 **Input**
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
180
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
181 Input is either a SAM or BAM file.
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
182
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
183 **Output**
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
184
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
185 The output file will be SAM or BAM (depending on the chosen option), filtered by the selected options.
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
186
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
187 **Options**
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
188
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
189 Filtering by read group or library requires headers in the input SAM or BAM file.
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
190
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
191 If regions are specified, only alignments overlapping the specified regions will be output. An alignment may be given multiple times if it is overlapping several regions.
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
192 A region can be presented, for example, in the following format::
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
193
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
194 chr2 (the whole chr2)
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
195 chr2:1000000 (region starting from 1,000,000bp)
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
196 chr2:1,000,000-2,000,000 (region between 1,000,000 and 2,000,000bp including the end points).
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
197
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
198 Note: The coordinate is 1-based.
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
199
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
200 Multiple regions may be specified, separated by a space character::
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
201
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
202 chr2:1000000-2000000 chr2:1,000,000-2,000,000 chrX
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
203
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
204
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
205
1
94d5786febc4 planemo upload commit 4381f4022eca6f3c58ae1d01096795cd28c15062
devteam
parents: 0
diff changeset
206 .. _SAMtools: http://samtools.sourceforge.net/
0
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
207
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
208 </help>
2d4ae2f8231e Imported from capsule None
devteam
parents:
diff changeset
209 </tool>