Mercurial > repos > jjohnson > samtools_filter
comparison README @ 1:f2e4e81f3639
Add tool_dependencies.xml and test-data
| author | Jim Johnson <jj@umn.edu> |
|---|---|
| date | Mon, 01 Apr 2013 10:57:16 -0500 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 0:5dcbce4f5971 | 1:f2e4e81f3639 |
|---|---|
| 1 **What it does** | |
| 2 | |
| 3 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. | |
| 4 | |
| 5 **Input** | |
| 6 | |
| 7 Input is either a SAM or BAM file. | |
| 8 | |
| 9 **Output** | |
| 10 | |
| 11 The output file will be of the same format a the Input file, filtered by the selected options. | |
| 12 | |
| 13 **Options** | |
| 14 | |
| 15 Filtering by read group or library requires headers in the input SAM or BAM file. | |
| 16 | |
| 17 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. | |
| 18 A region can be presented, for example, in the following format | |
| 19 | |
| 20 chr2 (the whole chr2) | |
| 21 chr2:1000000 (region starting from 1,000,000bp) | |
| 22 chr2:1,000,000-2,000,000 (region between 1,000,000 and 2,000,000bp including the end points). | |
| 23 | |
| 24 Note: The coordinate is 1-based. | |
| 25 | |
| 26 Multiple regions may be specified, separated by a space character | |
| 27 | |
| 28 chr2:1000000-2000000 chr2:1,000,000-2,000,000 chrX | |
| 29 |
