22 "git.arvados.org/arvados.git/sdk/go/arvados"
23 "github.com/arvados/lightning/hgvs"
24 "github.com/klauspost/pgzip"
25 log "github.com/sirupsen/logrus"
28 type tvVariant struct {
30 librefs map[tileLibRef]bool
33 type outputFormat struct {
35 Head func(out io.Writer, cgs []CompactGenome)
36 Print func(out io.Writer, seqname string, varslice []tvVariant)
41 outputFormats = map[string]outputFormat{
42 "hgvs-onehot": outputFormatHGVSOneHot,
43 "hgvs": outputFormatHGVS,
44 "pvcf": outputFormatPVCF,
45 "vcf": outputFormatVCF,
47 outputFormatHGVS = outputFormat{Filename: "out.tsv", Head: headNone, Print: printHGVS}
48 outputFormatHGVSOneHot = outputFormat{Filename: "out.tsv", Head: headNone, Print: printHGVSOneHot}
49 outputFormatPVCF = outputFormat{Filename: "out.vcf", Head: headPVCF, Print: printPVCF, PadLeft: true}
50 outputFormatVCF = outputFormat{Filename: "out.vcf", Head: headVCF, Print: printVCF, PadLeft: true}
51 headNone = func(io.Writer, []CompactGenome) {}
54 type exporter struct {
55 outputFormat outputFormat
61 func (cmd *exporter) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
65 fmt.Fprintf(stderr, "%s\n", err)
68 flags := flag.NewFlagSet("", flag.ContinueOnError)
69 flags.SetOutput(stderr)
70 pprof := flags.String("pprof", "", "serve Go profile data at http://`[addr]:port`")
71 pprofdir := flags.String("pprof-dir", "", "write Go profile data to `directory` periodically")
72 runlocal := flags.Bool("local", false, "run on local host (default: run in an arvados container)")
73 projectUUID := flags.String("project", "", "project `UUID` for output data")
74 priority := flags.Int("priority", 500, "container request priority")
75 refname := flags.String("ref", "", "reference genome `name`")
76 inputDir := flags.String("input-dir", ".", "input `directory`")
77 outputDir := flags.String("output-dir", ".", "output `directory`")
78 outputFormatStr := flags.String("output-format", "hgvs", "output `format`: hgvs, pvcf, or vcf")
79 outputBed := flags.String("output-bed", "", "also output bed `file`")
80 flags.BoolVar(&cmd.outputPerChrom, "output-per-chromosome", true, "output one file per chromosome")
81 flags.BoolVar(&cmd.compress, "z", false, "write gzip-compressed output files")
82 labelsFilename := flags.String("output-labels", "", "also output genome labels csv `file`")
83 flags.IntVar(&cmd.maxTileSize, "max-tile-size", 50000, "don't try to make annotations for tiles bigger than given `size`")
84 err = flags.Parse(args)
85 if err == flag.ErrHelp {
88 } else if err != nil {
92 err = fmt.Errorf("extra unparsed command line arguments: %q", flag.Args())
96 if f, ok := outputFormats[*outputFormatStr]; !ok {
97 err = fmt.Errorf("invalid output format %q", *outputFormatStr)
105 log.Println(http.ListenAndServe(*pprof, nil))
109 go writeProfilesPeriodically(*pprofdir)
113 if *outputDir != "." {
114 err = errors.New("cannot specify output directory in container mode: not implemented")
117 runner := arvadosContainerRunner{
118 Name: "lightning export",
119 Client: arvados.NewClientFromEnv(),
120 ProjectUUID: *projectUUID,
126 err = runner.TranslatePaths(inputDir)
130 if *outputBed != "" {
131 if strings.Contains(*outputBed, "/") {
132 err = fmt.Errorf("cannot use -output-bed filename %q containing '/' char", *outputBed)
135 *outputBed = "/mnt/output/" + *outputBed
137 runner.Args = []string{"export", "-local=true",
139 "-pprof-dir", "/mnt/output",
141 "-output-format", *outputFormatStr,
142 "-output-bed", *outputBed,
143 "-output-labels", "/mnt/output/labels.csv",
144 "-output-per-chromosome=" + fmt.Sprintf("%v", cmd.outputPerChrom),
145 "-max-tile-size", fmt.Sprintf("%d", cmd.maxTileSize),
146 "-input-dir", *inputDir,
147 "-output-dir", "/mnt/output",
148 "-z=" + fmt.Sprintf("%v", cmd.compress),
151 output, err = runner.Run()
155 fmt.Fprintln(stdout, output)
159 var cgs []CompactGenome
160 tilelib := &tileLibrary{
162 retainTileSequences: true,
163 compactGenomes: map[string][]tileVariantID{},
165 err = tilelib.LoadDir(context.Background(), *inputDir, nil)
170 refseq, ok := tilelib.refseqs[*refname]
172 err = fmt.Errorf("reference name %q not found in input; have %v", *refname, func() (names []string) {
173 for name := range tilelib.refseqs {
174 names = append(names, name)
181 names := cgnames(tilelib)
182 for _, name := range names {
183 cgs = append(cgs, CompactGenome{Name: name, Variants: tilelib.compactGenomes[name]})
185 if *labelsFilename != "" {
186 log.Infof("writing labels to %s", *labelsFilename)
188 f, err = os.OpenFile(*labelsFilename, os.O_CREATE|os.O_WRONLY, 0777)
193 for i, name := range names {
194 _, err = fmt.Fprintf(f, "%d,%q,%q\n", i, trimFilenameForLabel(name), cmd.outputFormat.Filename)
196 err = fmt.Errorf("write %s: %w", *labelsFilename, err)
202 err = fmt.Errorf("close %s: %w", *labelsFilename, err)
209 var bedbufw *bufio.Writer
210 if *outputBed != "" {
211 bedfile, err = os.OpenFile(*outputBed, os.O_CREATE|os.O_WRONLY, 0666)
215 defer bedfile.Close()
216 bedbufw = bufio.NewWriterSize(bedfile, 16*1024*1024)
220 err = cmd.export(*outputDir, bedout, tilelib, refseq, cgs)
225 err = bedbufw.Flush()
229 err = bedfile.Close()
237 func (cmd *exporter) export(outdir string, bedout io.Writer, tilelib *tileLibrary, refseq map[string][]tileLibRef, cgs []CompactGenome) error {
238 var seqnames []string
239 var missing []tileLibRef
240 for seqname, librefs := range refseq {
241 seqnames = append(seqnames, seqname)
242 for _, libref := range librefs {
243 if libref.Variant != 0 && tilelib.TileVariantSequence(libref) == nil {
244 missing = append(missing, libref)
248 sort.Strings(seqnames)
250 if len(missing) > 0 {
251 if limit := 100; len(missing) > limit {
252 log.Warnf("first %d missing tiles: %v", limit, missing[:limit])
254 log.Warnf("missing tiles: %v", missing)
256 return fmt.Errorf("%d needed tiles are missing from library", len(missing))
259 outw := make([]io.WriteCloser, len(seqnames))
260 bedw := make([]io.WriteCloser, len(seqnames))
262 var merges sync.WaitGroup
263 merge := func(dst io.Writer, src []io.WriteCloser, label string) {
265 for i, seqname := range seqnames {
272 log.Infof("writing %s %s", seqname, label)
273 scanner := bufio.NewScanner(pr)
276 dst.Write(scanner.Bytes())
277 dst.Write([]byte{'\n'})
280 log.Infof("writing %s %s done", seqname, label)
284 if cmd.outputPerChrom {
285 for i, seqname := range seqnames {
286 fnm := filepath.Join(outdir, strings.Replace(cmd.outputFormat.Filename, ".", "."+seqname+".", 1))
290 f, err := os.OpenFile(fnm, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0666)
295 log.Infof("writing %q", f.Name())
298 z := pgzip.NewWriter(f)
302 cmd.outputFormat.Head(outw[i], cgs)
305 fnm := filepath.Join(outdir, cmd.outputFormat.Filename)
309 f, err := os.OpenFile(fnm, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0666)
314 log.Infof("writing %q", fnm)
315 var out io.Writer = f
317 z := pgzip.NewWriter(out)
321 cmd.outputFormat.Head(out, cgs)
322 merge(out, outw, "output")
325 merge(bedout, bedw, "bed")
328 throttle := throttle{Max: runtime.NumCPU()}
329 log.Infof("assembling %d sequences in %d goroutines", len(seqnames), throttle.Max)
330 for seqidx, seqname := range seqnames {
331 seqidx, seqname := seqidx, seqname
336 defer throttle.Release()
340 outwb := bufio.NewWriterSize(outw, 8*1024*1024)
341 cmd.exportSeq(outwb, bedw, tilelib.taglib.keylen, seqname, refseq[seqname], tilelib, cgs)
351 return throttle.Err()
354 // Align genome tiles to reference tiles, write diffs to outw, and (if
355 // bedw is not nil) write tile coverage to bedw.
356 func (cmd *exporter) exportSeq(outw, bedw io.Writer, taglen int, seqname string, reftiles []tileLibRef, tilelib *tileLibrary, cgs []CompactGenome) {
358 progressbar := time.NewTicker(time.Minute)
359 defer progressbar.Stop()
360 var outmtx sync.Mutex
363 variantAt := map[int][]tvVariant{} // variantAt[chromOffset][genomeIndex*2+phase]
364 for refstep, libref := range reftiles {
366 case <-progressbar.C:
369 fin := t0.Add(time.Duration(float64(time.Now().Sub(t0)) * float64(len(reftiles)) / float64(refstep)))
370 eta = fmt.Sprintf("%v (%v)", fin.Format(time.RFC3339), fin.Sub(time.Now()))
374 log.Printf("exportSeq: %s: refstep %d of %d, %.0f/s, ETA %v", seqname, refstep, len(reftiles), float64(refstep)/time.Now().Sub(t0).Seconds(), eta)
377 diffs := map[tileLibRef][]hgvs.Variant{}
378 refseq := tilelib.TileVariantSequence(libref)
379 tagcoverage := 0 // number of times the start tag was found in genomes -- max is len(cgs)*2
380 for cgidx, cg := range cgs {
381 for phase := 0; phase < 2; phase++ {
382 if len(cg.Variants) <= int(libref.Tag)*2+phase {
385 variant := cg.Variants[int(libref.Tag)*2+phase]
390 if variant == libref.Variant {
393 glibref := tileLibRef{Tag: libref.Tag, Variant: variant}
394 vars, ok := diffs[glibref]
396 genomeseq := tilelib.TileVariantSequence(glibref)
397 if len(genomeseq) == 0 {
398 // Hash is known but sequence
399 // is not, e.g., retainNoCalls
400 // was false during import
403 if len(genomeseq) > cmd.maxTileSize {
406 refSequence := refseq
407 // If needed, extend the
408 // reference sequence up to
409 // the tag at the end of the
410 // genomeseq sequence.
411 refstepend := refstep + 1
412 for refstepend < len(reftiles) && len(refSequence) >= taglen && !bytes.EqualFold(refSequence[len(refSequence)-taglen:], genomeseq[len(genomeseq)-taglen:]) && len(refSequence) <= cmd.maxTileSize {
413 if &refSequence[0] == &refseq[0] {
414 refSequence = append([]byte(nil), refSequence...)
416 refSequence = append(refSequence, tilelib.TileVariantSequence(reftiles[refstepend])...)
419 // (TODO: handle no-calls)
420 if len(refSequence) <= cmd.maxTileSize {
421 refstr := strings.ToUpper(string(refSequence))
422 genomestr := strings.ToUpper(string(genomeseq))
423 vars, _ = hgvs.Diff(refstr, genomestr, time.Second)
425 diffs[glibref] = vars
427 for _, v := range vars {
428 if cmd.outputFormat.PadLeft {
432 varslice := variantAt[v.Position]
434 varslice = make([]tvVariant, len(cgs)*2)
435 variantAt[v.Position] = varslice
437 varslice[cgidx*2+phase].Variant = v
438 if varslice[cgidx*2+phase].librefs == nil {
439 varslice[cgidx*2+phase].librefs = map[tileLibRef]bool{glibref: true}
441 varslice[cgidx*2+phase].librefs[glibref] = true
446 refpos += len(refseq) - taglen
448 // Flush entries from variantAt that are behind
449 // refpos. Flush all entries if this is the last
450 // reftile of the path/chromosome.
451 flushpos := make([]int, 0, len(variantAt))
452 lastrefstep := refstep == len(reftiles)-1
453 for pos := range variantAt {
454 if lastrefstep || pos <= refpos {
455 flushpos = append(flushpos, pos)
458 sort.Slice(flushpos, func(i, j int) bool { return flushpos[i] < flushpos[j] })
459 flushvariants := make([][]tvVariant, len(flushpos))
460 for i, pos := range flushpos {
461 varslice := variantAt[pos]
462 delete(variantAt, pos)
463 for i := range varslice {
464 if varslice[i].Position == 0 {
465 varslice[i].Position = pos
468 flushvariants[i] = varslice
472 defer outmtx.Unlock()
473 for _, varslice := range flushvariants {
474 cmd.outputFormat.Print(outw, seqname, varslice)
477 if bedw != nil && len(refseq) > 0 {
478 tilestart := refpos - len(refseq) + taglen
483 thickstart := tilestart + taglen
489 // coverage score, 0 to 1000
492 score = 1000 * tagcoverage / len(cgs) / 2
495 fmt.Fprintf(bedw, "%s %d %d %d %d . %d %d\n",
496 seqname, tilestart, tileend,
499 thickstart, thickend)
504 func bucketVarsliceByRef(varslice []tvVariant) map[string]map[string]int {
505 byref := map[string]map[string]int{}
506 for _, v := range varslice {
507 if v.Ref == "" && v.New == "" {
512 alts = map[string]int{}
520 func headVCF(out io.Writer, cgs []CompactGenome) {
521 fmt.Fprint(out, "#CHROM\tPOS\tID\tREF\tALT\tQUAL\tFILTER\tINFO\n")
524 func printVCF(out io.Writer, seqname string, varslice []tvVariant) {
525 for ref, alts := range bucketVarsliceByRef(varslice) {
526 altslice := make([]string, 0, len(alts))
527 for alt := range alts {
528 altslice = append(altslice, alt)
530 sort.Strings(altslice)
533 for i, a := range altslice {
537 info += strconv.Itoa(alts[a])
539 fmt.Fprintf(out, "%s\t%d\t.\t%s\t%s\t.\t.\t%s\n", seqname, varslice[0].Position, ref, strings.Join(altslice, ","), info)
543 func headPVCF(out io.Writer, cgs []CompactGenome) {
544 fmt.Fprintln(out, `##FORMAT=<ID=GT,Number=1,Type=String,Description="Genotype">`)
545 fmt.Fprintf(out, "#CHROM\tPOS\tID\tREF\tALT\tQUAL\tFILTER\tINFO\tFORMAT")
546 for _, cg := range cgs {
547 fmt.Fprintf(out, "\t%s", cg.Name)
549 fmt.Fprintf(out, "\n")
552 func printPVCF(out io.Writer, seqname string, varslice []tvVariant) {
553 for ref, alts := range bucketVarsliceByRef(varslice) {
554 altslice := make([]string, 0, len(alts))
555 for alt := range alts {
556 altslice = append(altslice, alt)
558 sort.Strings(altslice)
559 for i, a := range altslice {
562 fmt.Fprintf(out, "%s\t%d\t.\t%s\t%s\t.\t.\t.\tGT", seqname, varslice[0].Position, ref, strings.Join(altslice, ","))
563 for i := 0; i < len(varslice); i += 2 {
564 v1, v2 := varslice[i], varslice[i+1]
565 a1, a2 := alts[v1.New], alts[v2.New]
567 // variant on allele 0 belongs on a
568 // different output line -- same
569 // chr,pos but different "ref" length
575 fmt.Fprintf(out, "\t%d/%d", a1, a2)
577 out.Write([]byte{'\n'})
581 func printHGVS(out io.Writer, seqname string, varslice []tvVariant) {
582 for i := 0; i < len(varslice)/2; i++ {
584 out.Write([]byte{'\t'})
586 var1, var2 := varslice[i*2], varslice[i*2+1]
587 if var1.Variant == var2.Variant {
588 if var1.Ref == var1.New {
589 out.Write([]byte{'.'})
591 fmt.Fprintf(out, "%s:g.%s", seqname, var1.String())
594 fmt.Fprintf(out, "%s:g.[%s];[%s]", seqname, var1.String(), var2.String())
597 out.Write([]byte{'\n'})
600 func printHGVSOneHot(out io.Writer, seqname string, varslice []tvVariant) {
601 vars := map[hgvs.Variant]bool{}
602 for _, v := range varslice {
604 vars[v.Variant] = true
608 // sort variants to ensure output is deterministic
609 sorted := make([]hgvs.Variant, 0, len(vars))
610 for v := range vars {
611 sorted = append(sorted, v)
613 sort.Slice(sorted, func(a, b int) bool { return hgvs.Less(sorted[a], sorted[b]) })
615 for _, v := range sorted {
616 fmt.Fprintf(out, "%s.%s", seqname, v.String())
617 for i := 0; i < len(varslice); i += 2 {
618 if varslice[i].Variant == v || varslice[i+1].Variant == v {
619 out.Write([]byte("\t1"))
621 out.Write([]byte("\t0"))
624 out.Write([]byte{'\n'})