1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
// Package vcfgo implements a Reader and Writer for variant call format.
// It eases reading, filtering modifying VCF's even if they are not to spec.
// Example:
// f, _ := os.Open("examples/test.auto_dom.no_parents.vcf")
// rdr, err := vcfgo.NewReader(f)
// if err != nil {
// panic(err)
// }
// for {
// variant := rdr.Read()
// if variant == nil {
// break
// }
// fmt.Printf("%s\t%d\t%s\t%s\n", variant.Chromosome, variant.Pos, variant.Ref, variant.Alt)
// fmt.Printf("%s", variant.Info["DP"].(int) > 10)
// sample := variant.Samples[0]
// // we can get the PL field as a list (-1 is default in case of missing value)
// fmt.Println("%s", variant.GetGenotypeField(sample, "PL", -1))
// _ = sample.DP
// }
// fmt.Fprintln(os.Stderr, rdr.Error())
package vcfgo
import (
"bufio"
"bytes"
"fmt"
"io"
"log"
"os"
"strconv"
"strings"
"unsafe"
)
// used for the quality score which is 0 to 255, but allows "."
const MISSING_VAL = 256
// Reader holds information about the current line number (for errors) and
// The VCF header that indicates the structure of records.
type Reader struct {
buf *bufio.Reader
Header *Header
verr *VCFError
LineNumber int64
lazySamples bool
r io.Reader
}
func NewWithHeader(r io.Reader, h *Header, lazySamples bool) (*Reader, error) {
buf := bufio.NewReaderSize(r, 32768*2)
var verr = NewVCFError()
return &Reader{buf, h, verr, 1, lazySamples, r}, nil
}
// NewReader returns a Reader.
// If lazySamples is true, then the user will have to call Reader.ParseSamples()
// in order to access simple info.
func NewReader(r io.Reader, lazySamples bool) (*Reader, error) {
buffered := bufio.NewReaderSize(r, 32768*2)
var verr = NewVCFError()
var LineNumber int64
h := NewHeader()
for {
LineNumber++
line, err := buffered.ReadString('\n')
if err != nil && err != io.EOF {
verr.Add(err, LineNumber)
}
if len(line) > 1 && line[len(line)-1] == '\n' {
line = line[:len(line)-1]
}
if LineNumber == 1 {
v, err := parseHeaderFileVersion(line)
verr.Add(err, LineNumber)
h.FileFormat = v
} else if strings.HasPrefix(line, "##FORMAT") {
format, err := parseHeaderFormat(line)
verr.Add(err, LineNumber)
if format != nil {
h.SampleFormats[format.Id] = format
}
} else if strings.HasPrefix(line, "##INFO") {
info, err := parseHeaderInfo(line)
verr.Add(err, LineNumber)
if info != nil {
h.Infos[info.Id] = info
}
} else if strings.HasPrefix(line, "##FILTER") {
filter, err := parseHeaderFilter(line)
verr.Add(err, LineNumber)
if filter != nil && len(filter) == 2 {
h.Filters[filter[0]] = filter[1]
}
} else if strings.HasPrefix(line, "##contig") {
contig, err := parseHeaderContig(line)
verr.Add(err, LineNumber)
if contig != nil {
if _, ok := contig["ID"]; ok {
h.Contigs = append(h.Contigs, contig)
} else {
verr.Add(fmt.Errorf("bad contig: %v", line), LineNumber)
}
}
} else if strings.HasPrefix(line, "##SAMPLE") {
sample, err := parseHeaderSample(line)
verr.Add(err, LineNumber)
if sample != "" {
h.Samples[sample] = line
} else {
verr.Add(fmt.Errorf("bad sample: %v", line), LineNumber)
}
} else if strings.HasPrefix(line, "##PEDIGREE") {
h.Pedigrees = append(h.Pedigrees, line)
} else if strings.HasPrefix(line, "##") {
kv, err := parseHeaderExtraKV(line)
verr.Add(err, LineNumber)
if kv != nil && len(kv) == 2 {
h.Extras = append(h.Extras, line)
}
} else if strings.HasPrefix(line, "#CHROM") {
var err error
h.SampleNames, err = parseSampleLine(line)
verr.Add(err, LineNumber)
//h.Validate(verr)
break
} else {
e := fmt.Errorf("unexpected header line: %s", line)
return nil, e
}
}
reader := &Reader{buffered, h, verr, LineNumber, lazySamples, r}
return reader, reader.Error()
}
func makeFields(line []byte) [][]byte {
fields := bytes.SplitN(line, []byte{'\t'}, 9)
s := 0
for i, f := range fields {
if i == 7 {
break
}
s += len(f) + 1
}
if s >= len(line) {
fmt.Fprintf(os.Stderr, "XXXXX: bad VCF line '%s'", line)
return fields
}
e := bytes.IndexByte(line[s:], '\t')
if e == -1 {
e = len(line)
} else {
e += s
}
fields[7] = line[s:e]
return fields
}
// Read returns a pointer to a Variant. Upon reading the caller is assumed
// to check Reader.Err()
func (vr *Reader) Read() *Variant {
line, err := vr.buf.ReadBytes('\n')
if err != nil {
if len(line) == 0 && err == io.EOF {
return nil
} else if err != io.EOF {
vr.verr.Add(err, vr.LineNumber)
}
}
vr.LineNumber++
if line[len(line)-1] == '\n' {
line = line[:len(line)-1]
}
fields := makeFields(line)
return vr.Parse(fields)
}
func unsafeString(b []byte) string {
return *(*string)(unsafe.Pointer(&b))
}
func (vr *Reader) Parse(fields [][]byte) *Variant {
if len(fields) < 7 {
s := make([]string, 0)
for _, b := range fields {
s = append(s, string(b))
}
log.Printf("error at line %d: not enough fields for a VCF. Content was: '%s'\n", vr.LineNumber, strings.Join(s, "\t"))
}
pos, err := strconv.ParseUint(unsafeString(fields[1]), 10, 64)
vr.verr.Add(err, vr.LineNumber)
var qual float64
if len(fields[5]) == 1 && fields[5][0] == '.' {
qual = MISSING_VAL
} else {
qual, err = strconv.ParseFloat(unsafeString(fields[5]), 32)
vr.verr.Add(err, vr.LineNumber)
}
v := &Variant{Chromosome: string(fields[0]), Pos: pos, Id_: string(fields[2]), Reference: string(fields[3]), Alternate: strings.Split(string(fields[4]), ","), Quality: float32(qual),
Filter: string(fields[6]), Header: vr.Header}
if len(fields) > 8 {
sample_fields := bytes.SplitN(fields[8], []byte{'\t'}, 2)
v.Format = strings.Split(string(sample_fields[0]), ":")
v.sampleString = string(sample_fields[1])
if !vr.lazySamples {
err = vr.Header.ParseSamples(v)
vr.verr.Add(err, vr.LineNumber)
}
}
v.LineNumber = vr.LineNumber
v.Info_ = NewInfoByte(fields[7], vr.Header)
return v
}
// Force parsing of the sample fields.
func (h *Header) ParseSamples(v *Variant) error {
if v.Format == nil || v.sampleString == "" || v.Samples != nil {
return nil
}
var errors []error
v.Samples = make([]*SampleGenotype, len(h.SampleNames))
for i, sample := range strings.Split(v.sampleString, "\t") {
geno, moreErrors := h.parseSample(v.Format, sample)
errors = append(errors, moreErrors...)
v.Samples[i] = geno
}
v.sampleString = ""
if len(errors) > 0 {
return errors[0]
}
return nil
}
// AddInfoToHeader adds a INFO field to the header.
func (vr *Reader) AddInfoToHeader(id string, num string, stype string, desc string) {
h := vr.Header
h.Infos[id] = &Info{Id: id, Number: num, Type: stype, Description: desc}
}
// AddFormatToHeader adds a FORMAT field to the header.
func (vr *Reader) AddFormatToHeader(id string, num string, stype string, desc string) {
h := vr.Header
h.SampleFormats[id] = &SampleFormat{Id: id, Number: num, Type: stype, Description: desc}
}
func (vr *Reader) GetHeaderType(field string) string {
if h, ok := vr.Header.Infos[field]; ok {
return h.Type
}
return ""
}
// Error() aggregates the multiple errors that can occur into a single object.
func (vr *Reader) Error() error {
if vr.verr.IsEmpty() {
return nil
}
return vr.verr
}
// Clear empties the cache of errors.
func (vr *Reader) Clear() {
vr.verr.Clear()
}
func (vr *Reader) Close() error {
if rc, ok := vr.r.(io.ReadCloser); ok {
return rc.Close()
}
return nil
}
|