annotate ezBAMQC/src/htslib/sam.5 @ 20:9de3bbec2479 draft default tip

Uploaded
author youngkim
date Thu, 31 Mar 2016 10:10:37 -0400
parents dfa3745e5fd8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
1 '\" t
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
2 .TH sam 5 "August 2013" "htslib" "Bioinformatics formats"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
3 .SH NAME
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
4 sam \- Sequence Alignment/Map file format
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
5 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
6 .\" Copyright (C) 2009, 2013 Genome Research Ltd.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
7 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
8 .\" Author: Heng Li <lh3@sanger.ac.uk>
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
9 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
10 .\" Permission is hereby granted, free of charge, to any person obtaining a
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
11 .\" copy of this software and associated documentation files (the "Software"),
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
12 .\" to deal in the Software without restriction, including without limitation
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
13 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
14 .\" and/or sell copies of the Software, and to permit persons to whom the
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
15 .\" Software is furnished to do so, subject to the following conditions:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
16 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
17 .\" The above copyright notice and this permission notice shall be included in
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
18 .\" all copies or substantial portions of the Software.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
19 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
20 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
21 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
22 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
23 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
24 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
25 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
26 .\" DEALINGS IN THE SOFTWARE.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
27 .\"
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
28 .SH DESCRIPTION
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
29 Sequence Alignment/Map (SAM) format is TAB-delimited. Apart from the header lines, which are started
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
30 with the `@' symbol, each alignment line consists of:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
31 .TS
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
32 nlbl.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
33 1 QNAME Query template/pair NAME
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
34 2 FLAG bitwise FLAG
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
35 3 RNAME Reference sequence NAME
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
36 4 POS 1-based leftmost POSition/coordinate of clipped sequence
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
37 5 MAPQ MAPping Quality (Phred-scaled)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
38 6 CIGAR extended CIGAR string
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
39 7 MRNM Mate Reference sequence NaMe (`=' if same as RNAME)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
40 8 MPOS 1-based Mate POSistion
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
41 9 TLEN inferred Template LENgth (insert size)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
42 10 SEQ query SEQuence on the same strand as the reference
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
43 11 QUAL query QUALity (ASCII-33 gives the Phred base quality)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
44 12+ OPT variable OPTional fields in the format TAG:VTYPE:VALUE
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
45 .TE
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
46 .PP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
47 Each bit in the FLAG field is defined as:
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
48 .TS
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
49 lcbl.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
50 0x0001 p the read is paired in sequencing
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
51 0x0002 P the read is mapped in a proper pair
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
52 0x0004 u the query sequence itself is unmapped
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
53 0x0008 U the mate is unmapped
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
54 0x0010 r strand of the query (1 for reverse)
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
55 0x0020 R strand of the mate
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
56 0x0040 1 the read is the first read in a pair
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
57 0x0080 2 the read is the second read in a pair
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
58 0x0100 s the alignment is not primary
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
59 0x0200 f the read fails platform/vendor quality checks
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
60 0x0400 d the read is either a PCR or an optical duplicate
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
61 0x0800 S the alignment is supplementary
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
62 .TE
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
63 .P
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
64 where the second column gives the string representation of the FLAG field.
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
65 .SH SEE ALSO
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
66 .TP
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
67 https://github.com/samtools/hts-specs
dfa3745e5fd8 Uploaded
youngkim
parents:
diff changeset
68 The full SAM/BAM file format specification