1 // Copyright (C) The Lightning Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
26 "git.arvados.org/arvados.git/sdk/go/arvados"
27 "github.com/arvados/lightning/hgvs"
28 "github.com/klauspost/pgzip"
29 "github.com/kshedden/gonpy"
30 "github.com/sirupsen/logrus"
31 log "github.com/sirupsen/logrus"
34 type tvVariant struct {
36 librefs map[tileLibRef]bool
39 type outputFormat interface {
42 Head(out io.Writer, cgs []CompactGenome) error
43 Print(out io.Writer, seqname string, varslice []tvVariant) error
44 Finish(outdir string, out io.Writer, seqname string) error
48 var outputFormats = map[string]func() outputFormat{
49 "hgvs-numpy": func() outputFormat {
50 return &formatHGVSNumpy{alleles: map[string][][]bool{}}
52 "hgvs-onehot": func() outputFormat { return formatHGVSOneHot{} },
53 "hgvs": func() outputFormat { return formatHGVS{} },
54 "pvcf": func() outputFormat { return formatPVCF{} },
55 "vcf": func() outputFormat { return formatVCF{} },
58 type exporter struct {
59 outputFormat outputFormat
66 func (cmd *exporter) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
70 fmt.Fprintf(stderr, "%s\n", err)
73 flags := flag.NewFlagSet("", flag.ContinueOnError)
74 flags.SetOutput(stderr)
75 pprof := flags.String("pprof", "", "serve Go profile data at http://`[addr]:port`")
76 pprofdir := flags.String("pprof-dir", "", "write Go profile data to `directory` periodically")
77 runlocal := flags.Bool("local", false, "run on local host (default: run in an arvados container)")
78 projectUUID := flags.String("project", "", "project `UUID` for output data")
79 priority := flags.Int("priority", 500, "container request priority")
80 refname := flags.String("ref", "", "reference genome `name`")
81 inputDir := flags.String("input-dir", ".", "input `directory`")
82 outputDir := flags.String("output-dir", ".", "output `directory`")
83 outputFormatStr := flags.String("output-format", "hgvs", "output `format`: hgvs, pvcf, or vcf")
84 outputBed := flags.String("output-bed", "", "also output bed `file`")
85 flags.BoolVar(&cmd.outputPerChrom, "output-per-chromosome", true, "output one file per chromosome")
86 flags.BoolVar(&cmd.compress, "z", false, "write gzip-compressed output files")
87 labelsFilename := flags.String("output-labels", "", "also output genome labels csv `file`")
88 flags.IntVar(&cmd.maxTileSize, "max-tile-size", 50000, "don't try to make annotations for tiles bigger than given `size`")
89 cmd.filter.Flags(flags)
90 err = flags.Parse(args)
91 if err == flag.ErrHelp {
94 } else if err != nil {
98 err = fmt.Errorf("extra unparsed command line arguments: %q", flag.Args())
102 if f, ok := outputFormats[*outputFormatStr]; !ok {
103 err = fmt.Errorf("invalid output format %q", *outputFormatStr)
106 cmd.outputFormat = f()
111 log.Println(http.ListenAndServe(*pprof, nil))
115 go writeProfilesPeriodically(*pprofdir)
119 if *outputDir != "." {
120 err = errors.New("cannot specify output directory in container mode: not implemented")
123 runner := arvadosContainerRunner{
124 Name: "lightning export",
125 Client: arvados.NewClientFromEnv(),
126 ProjectUUID: *projectUUID,
132 err = runner.TranslatePaths(inputDir)
136 if *outputBed != "" {
137 if strings.Contains(*outputBed, "/") {
138 err = fmt.Errorf("cannot use -output-bed filename %q containing '/' char", *outputBed)
141 *outputBed = "/mnt/output/" + *outputBed
143 runner.Args = []string{"export", "-local=true",
145 "-pprof-dir", "/mnt/output",
147 "-output-format", *outputFormatStr,
148 "-output-bed", *outputBed,
149 "-output-labels", "/mnt/output/labels.csv",
150 "-output-per-chromosome=" + fmt.Sprintf("%v", cmd.outputPerChrom),
151 "-max-tile-size", fmt.Sprintf("%d", cmd.maxTileSize),
152 "-input-dir", *inputDir,
153 "-output-dir", "/mnt/output",
154 "-z=" + fmt.Sprintf("%v", cmd.compress),
156 runner.Args = append(runner.Args, cmd.filter.Args()...)
158 output, err = runner.Run()
162 fmt.Fprintln(stdout, output)
166 var cgs []CompactGenome
167 tilelib := &tileLibrary{
169 retainTileSequences: true,
170 compactGenomes: map[string][]tileVariantID{},
172 err = tilelib.LoadDir(context.Background(), *inputDir, nil)
177 refseq, ok := tilelib.refseqs[*refname]
179 err = fmt.Errorf("reference name %q not found in input; have %v", *refname, func() (names []string) {
180 for name := range tilelib.refseqs {
181 names = append(names, name)
188 log.Infof("filtering: %+v", cmd.filter)
189 cmd.filter.Apply(tilelib)
191 names := cgnames(tilelib)
192 for _, name := range names {
193 cgs = append(cgs, CompactGenome{Name: name, Variants: tilelib.compactGenomes[name]})
195 if *labelsFilename != "" {
196 log.Infof("writing labels to %s", *labelsFilename)
198 f, err = os.OpenFile(*labelsFilename, os.O_CREATE|os.O_WRONLY, 0777)
203 for i, name := range names {
204 _, err = fmt.Fprintf(f, "%d,%q,%q\n", i, trimFilenameForLabel(name), cmd.outputFormat.Filename())
206 err = fmt.Errorf("write %s: %w", *labelsFilename, err)
212 err = fmt.Errorf("close %s: %w", *labelsFilename, err)
219 var bedbufw *bufio.Writer
220 if *outputBed != "" {
221 bedfile, err = os.OpenFile(*outputBed, os.O_CREATE|os.O_WRONLY, 0666)
225 defer bedfile.Close()
226 bedbufw = bufio.NewWriterSize(bedfile, 16*1024*1024)
230 err = cmd.export(*outputDir, bedout, tilelib, refseq, cgs)
235 err = bedbufw.Flush()
239 err = bedfile.Close()
247 func (cmd *exporter) export(outdir string, bedout io.Writer, tilelib *tileLibrary, refseq map[string][]tileLibRef, cgs []CompactGenome) error {
248 var seqnames []string
249 var missing []tileLibRef
250 for seqname, librefs := range refseq {
251 seqnames = append(seqnames, seqname)
252 for _, libref := range librefs {
253 if libref.Variant != 0 && tilelib.TileVariantSequence(libref) == nil {
254 missing = append(missing, libref)
258 sort.Strings(seqnames)
260 if len(missing) > 0 {
261 if limit := 100; len(missing) > limit {
262 log.Warnf("first %d missing tiles: %v", limit, missing[:limit])
264 log.Warnf("missing tiles: %v", missing)
266 return fmt.Errorf("%d needed tiles are missing from library", len(missing))
269 outw := make([]io.WriteCloser, len(seqnames))
270 bedw := make([]io.WriteCloser, len(seqnames))
272 var merges sync.WaitGroup
273 merge := func(dst io.Writer, src []io.WriteCloser, label string) {
275 for i, seqname := range seqnames {
282 log.Infof("writing %s %s", seqname, label)
283 scanner := bufio.NewScanner(pr)
286 dst.Write(scanner.Bytes())
287 dst.Write([]byte{'\n'})
290 log.Infof("writing %s %s done", seqname, label)
294 if cmd.outputPerChrom {
295 for i, seqname := range seqnames {
296 fnm := filepath.Join(outdir, strings.Replace(cmd.outputFormat.Filename(), ".", "."+seqname+".", 1))
300 f, err := os.OpenFile(fnm, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0666)
305 log.Infof("writing %q", f.Name())
308 z := pgzip.NewWriter(f)
312 err = cmd.outputFormat.Head(outw[i], cgs)
318 fnm := filepath.Join(outdir, cmd.outputFormat.Filename())
322 f, err := os.OpenFile(fnm, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0666)
327 log.Infof("writing %q", fnm)
328 var out io.Writer = f
330 z := pgzip.NewWriter(out)
334 cmd.outputFormat.Head(out, cgs)
335 merge(out, outw, "output")
338 merge(bedout, bedw, "bed")
341 throttle := throttle{Max: runtime.NumCPU()}
342 if max := cmd.outputFormat.MaxGoroutines(); max > 0 {
345 log.Infof("assembling %d sequences in %d goroutines", len(seqnames), throttle.Max)
346 for seqidx, seqname := range seqnames {
347 seqidx, seqname := seqidx, seqname
352 defer throttle.Release()
356 outwb := bufio.NewWriterSize(outw, 8*1024*1024)
357 eachVariant(bedw, tilelib.taglib.keylen, seqname, refseq[seqname], tilelib, cgs, cmd.outputFormat.PadLeft(), cmd.maxTileSize, func(varslice []tvVariant) {
358 err := cmd.outputFormat.Print(outwb, seqname, varslice)
361 err := cmd.outputFormat.Finish(outdir, outwb, seqname)
372 return throttle.Err()
375 // Align genome tiles to reference tiles, call callback func on each
376 // variant, and (if bedw is not nil) write tile coverage to bedw.
377 func eachVariant(bedw io.Writer, taglen int, seqname string, reftiles []tileLibRef, tilelib *tileLibrary, cgs []CompactGenome, padLeft bool, maxTileSize int, callback func(varslice []tvVariant)) {
379 progressbar := time.NewTicker(time.Minute)
380 defer progressbar.Stop()
381 var outmtx sync.Mutex
384 variantAt := map[int][]tvVariant{} // variantAt[chromOffset][genomeIndex*2+phase]
385 for refstep, libref := range reftiles {
387 case <-progressbar.C:
390 fin := t0.Add(time.Duration(float64(time.Now().Sub(t0)) * float64(len(reftiles)) / float64(refstep)))
391 eta = fmt.Sprintf("%v (%v)", fin.Format(time.RFC3339), fin.Sub(time.Now()))
395 log.Printf("exportSeq: %s: refstep %d of %d, %.0f/s, ETA %v", seqname, refstep, len(reftiles), float64(refstep)/time.Now().Sub(t0).Seconds(), eta)
398 diffs := map[tileLibRef][]hgvs.Variant{}
399 refseq := tilelib.TileVariantSequence(libref)
400 tagcoverage := 0 // number of times the start tag was found in genomes -- max is len(cgs)*2
401 for cgidx, cg := range cgs {
402 for phase := 0; phase < 2; phase++ {
403 if len(cg.Variants) <= int(libref.Tag)*2+phase {
406 variant := cg.Variants[int(libref.Tag)*2+phase]
411 if variant == libref.Variant {
414 glibref := tileLibRef{Tag: libref.Tag, Variant: variant}
415 vars, ok := diffs[glibref]
417 genomeseq := tilelib.TileVariantSequence(glibref)
418 if len(genomeseq) == 0 {
419 // Hash is known but sequence
420 // is not, e.g., retainNoCalls
421 // was false during import
424 if len(genomeseq) > maxTileSize {
427 refSequence := refseq
428 // If needed, extend the
429 // reference sequence up to
430 // the tag at the end of the
431 // genomeseq sequence.
432 refstepend := refstep + 1
433 for refstepend < len(reftiles) && len(refSequence) >= taglen && !bytes.EqualFold(refSequence[len(refSequence)-taglen:], genomeseq[len(genomeseq)-taglen:]) && len(refSequence) <= maxTileSize {
434 if &refSequence[0] == &refseq[0] {
435 refSequence = append([]byte(nil), refSequence...)
437 refSequence = append(refSequence, tilelib.TileVariantSequence(reftiles[refstepend])...)
440 // (TODO: handle no-calls)
441 if len(refSequence) <= maxTileSize {
442 refstr := strings.ToUpper(string(refSequence))
443 genomestr := strings.ToUpper(string(genomeseq))
444 vars, _ = hgvs.Diff(refstr, genomestr, time.Second)
446 diffs[glibref] = vars
448 for _, v := range vars {
453 varslice := variantAt[v.Position]
455 varslice = make([]tvVariant, len(cgs)*2)
456 variantAt[v.Position] = varslice
458 varslice[cgidx*2+phase].Variant = v
459 if varslice[cgidx*2+phase].librefs == nil {
460 varslice[cgidx*2+phase].librefs = map[tileLibRef]bool{glibref: true}
462 varslice[cgidx*2+phase].librefs[glibref] = true
467 refpos += len(refseq) - taglen
469 // Flush entries from variantAt that are behind
470 // refpos. Flush all entries if this is the last
471 // reftile of the path/chromosome.
472 flushpos := make([]int, 0, len(variantAt))
473 lastrefstep := refstep == len(reftiles)-1
474 for pos := range variantAt {
475 if lastrefstep || pos <= refpos {
476 flushpos = append(flushpos, pos)
479 sort.Slice(flushpos, func(i, j int) bool { return flushpos[i] < flushpos[j] })
480 flushvariants := make([][]tvVariant, len(flushpos))
481 for i, pos := range flushpos {
482 varslice := variantAt[pos]
483 delete(variantAt, pos)
484 for i := range varslice {
485 if varslice[i].Position == 0 {
486 varslice[i].Position = pos
489 flushvariants[i] = varslice
493 defer outmtx.Unlock()
494 for _, varslice := range flushvariants {
498 if bedw != nil && len(refseq) > 0 {
499 tilestart := refpos - len(refseq) + taglen
504 thickstart := tilestart + taglen
510 // coverage score, 0 to 1000
513 score = 1000 * tagcoverage / len(cgs) / 2
516 fmt.Fprintf(bedw, "%s %d %d %d %d . %d %d\n",
517 seqname, tilestart, tileend,
520 thickstart, thickend)
525 func bucketVarsliceByRef(varslice []tvVariant) map[string]map[string]int {
526 byref := map[string]map[string]int{}
527 for _, v := range varslice {
528 if v.Ref == "" && v.New == "" {
533 alts = map[string]int{}
541 type formatVCF struct{}
543 func (formatVCF) MaxGoroutines() int { return 0 }
544 func (formatVCF) Filename() string { return "out.vcf" }
545 func (formatVCF) PadLeft() bool { return true }
546 func (formatVCF) Finish(string, io.Writer, string) error { return nil }
547 func (formatVCF) Head(out io.Writer, cgs []CompactGenome) error {
548 _, err := fmt.Fprint(out, "#CHROM\tPOS\tID\tREF\tALT\tQUAL\tFILTER\tINFO\n")
551 func (formatVCF) Print(out io.Writer, seqname string, varslice []tvVariant) error {
552 for ref, alts := range bucketVarsliceByRef(varslice) {
553 altslice := make([]string, 0, len(alts))
554 for alt := range alts {
555 altslice = append(altslice, alt)
557 sort.Strings(altslice)
560 for i, a := range altslice {
564 info += strconv.Itoa(alts[a])
566 _, err := 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)
574 type formatPVCF struct{}
576 func (formatPVCF) MaxGoroutines() int { return 0 }
577 func (formatPVCF) Filename() string { return "out.vcf" }
578 func (formatPVCF) PadLeft() bool { return true }
579 func (formatPVCF) Finish(string, io.Writer, string) error { return nil }
580 func (formatPVCF) Head(out io.Writer, cgs []CompactGenome) error {
581 fmt.Fprintln(out, `##FORMAT=<ID=GT,Number=1,Type=String,Description="Genotype">`)
582 fmt.Fprintf(out, "#CHROM\tPOS\tID\tREF\tALT\tQUAL\tFILTER\tINFO\tFORMAT")
583 for _, cg := range cgs {
584 fmt.Fprintf(out, "\t%s", cg.Name)
586 _, err := fmt.Fprintf(out, "\n")
590 func (formatPVCF) Print(out io.Writer, seqname string, varslice []tvVariant) error {
591 for ref, alts := range bucketVarsliceByRef(varslice) {
592 altslice := make([]string, 0, len(alts))
593 for alt := range alts {
594 altslice = append(altslice, alt)
596 sort.Strings(altslice)
597 for i, a := range altslice {
600 _, err := fmt.Fprintf(out, "%s\t%d\t.\t%s\t%s\t.\t.\t.\tGT", seqname, varslice[0].Position, ref, strings.Join(altslice, ","))
604 for i := 0; i < len(varslice); i += 2 {
605 v1, v2 := varslice[i], varslice[i+1]
606 a1, a2 := alts[v1.New], alts[v2.New]
608 // variant on allele 0 belongs on a
609 // different output line -- same
610 // chr,pos but different "ref" length
616 _, err := fmt.Fprintf(out, "\t%d/%d", a1, a2)
621 _, err = out.Write([]byte{'\n'})
629 type formatHGVS struct{}
631 func (formatHGVS) MaxGoroutines() int { return 0 }
632 func (formatHGVS) Filename() string { return "out.tsv" }
633 func (formatHGVS) PadLeft() bool { return false }
634 func (formatHGVS) Head(out io.Writer, cgs []CompactGenome) error { return nil }
635 func (formatHGVS) Finish(string, io.Writer, string) error { return nil }
636 func (formatHGVS) Print(out io.Writer, seqname string, varslice []tvVariant) error {
637 for i := 0; i < len(varslice)/2; i++ {
639 out.Write([]byte{'\t'})
641 var1, var2 := varslice[i*2], varslice[i*2+1]
642 if var1.Variant == var2.Variant {
643 if var1.Ref == var1.New {
644 _, err := out.Write([]byte{'.'})
649 _, err := fmt.Fprintf(out, "%s:g.%s", seqname, var1.String())
655 _, err := fmt.Fprintf(out, "%s:g.[%s];[%s]", seqname, var1.String(), var2.String())
661 _, err := out.Write([]byte{'\n'})
665 type formatHGVSOneHot struct{}
667 func (formatHGVSOneHot) MaxGoroutines() int { return 0 }
668 func (formatHGVSOneHot) Filename() string { return "out.tsv" }
669 func (formatHGVSOneHot) PadLeft() bool { return false }
670 func (formatHGVSOneHot) Head(out io.Writer, cgs []CompactGenome) error { return nil }
671 func (formatHGVSOneHot) Finish(string, io.Writer, string) error { return nil }
672 func (formatHGVSOneHot) Print(out io.Writer, seqname string, varslice []tvVariant) error {
673 vars := map[hgvs.Variant]bool{}
674 for _, v := range varslice {
676 vars[v.Variant] = true
680 // sort variants to ensure output is deterministic
681 sorted := make([]hgvs.Variant, 0, len(vars))
682 for v := range vars {
683 sorted = append(sorted, v)
685 sort.Slice(sorted, func(a, b int) bool { return hgvs.Less(sorted[a], sorted[b]) })
687 for _, v := range sorted {
688 fmt.Fprintf(out, "%s.%s", seqname, v.String())
689 for i := 0; i < len(varslice); i += 2 {
690 if varslice[i].Variant == v || varslice[i+1].Variant == v {
691 out.Write([]byte("\t1"))
693 out.Write([]byte("\t0"))
696 _, err := out.Write([]byte{'\n'})
704 type formatHGVSNumpy struct {
707 alleles map[string][][]bool // alleles[seqname][variantidx][genomeidx*2+phase]
710 func (*formatHGVSNumpy) MaxGoroutines() int { return 4 }
711 func (*formatHGVSNumpy) Filename() string { return "annotations.csv" }
712 func (*formatHGVSNumpy) PadLeft() bool { return false }
713 func (*formatHGVSNumpy) Head(out io.Writer, cgs []CompactGenome) error { return nil }
714 func (f *formatHGVSNumpy) Print(outw io.Writer, seqname string, varslice []tvVariant) error {
715 // sort variants to ensure output is deterministic
716 sorted := make([]hgvs.Variant, 0, len(varslice))
717 for _, v := range varslice {
718 sorted = append(sorted, v.Variant)
720 sort.Slice(sorted, func(a, b int) bool { return hgvs.Less(sorted[a], sorted[b]) })
723 seqalleles := f.alleles[seqname]
726 // append a row to seqvariants and seqalleles for each unique
727 // non-ref variant in varslice.
728 var previous hgvs.Variant
729 for _, v := range sorted {
730 if previous == v || v.Ref == v.New {
734 newrow := make([]bool, len(varslice))
735 for i, allele := range varslice {
736 if allele.Variant == v {
740 seqalleles = append(seqalleles, newrow)
741 _, err := fmt.Fprintf(outw, "%d,%q\n", len(seqalleles)-1, seqname+"."+v.String())
748 f.alleles[seqname] = seqalleles
752 func (f *formatHGVSNumpy) Finish(outdir string, _ io.Writer, seqname string) error {
753 // Write seqname's data to a .npy matrix with one row per
754 // genome and 2 columns per variant.
755 seqalleles := f.alleles[seqname]
757 delete(f.alleles, seqname)
759 if len(seqalleles) == 0 {
762 out := make([]int8, len(seqalleles)*len(seqalleles[0]))
763 rows := len(seqalleles[0]) / 2
764 cols := len(seqalleles) * 2
765 // copy seqalleles[varidx][genome*2+phase] to
766 // out[genome*nvars*2 + varidx*2 + phase]
767 for varidx, alleles := range seqalleles {
768 for g := 0; g < len(alleles)/2; g++ {
769 aa, ab := alleles[g*2], alleles[g*2+1]
772 out[g*cols+varidx*2] = 1
775 out[g*cols+varidx*2+1] = 1
779 outf, err := os.OpenFile(outdir+"/matrix."+seqname+".npy", os.O_CREATE|os.O_EXCL|os.O_WRONLY, 0777)
784 bufw := bufio.NewWriter(outf)
785 npw, err := gonpy.NewWriter(nopCloser{bufw})
789 log.WithFields(logrus.Fields{
793 }).Info("writing numpy")
794 npw.Shape = []int{rows, cols}
795 f.writelock.Lock() // serialize because WriteInt8 uses lots of memory