1 // Copyright (C) The Lightning Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
25 "git.arvados.org/arvados.git/sdk/go/arvados"
26 "github.com/arvados/lightning/hgvs"
27 "github.com/kshedden/gonpy"
28 log "github.com/sirupsen/logrus"
29 "golang.org/x/crypto/blake2b"
32 type sliceNumpy struct {
37 func (cmd *sliceNumpy) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
41 fmt.Fprintf(stderr, "%s\n", err)
44 flags := flag.NewFlagSet("", flag.ContinueOnError)
45 flags.SetOutput(stderr)
46 pprof := flags.String("pprof", "", "serve Go profile data at http://`[addr]:port`")
47 runlocal := flags.Bool("local", false, "run on local host (default: run in an arvados container)")
48 projectUUID := flags.String("project", "", "project `UUID` for output data")
49 priority := flags.Int("priority", 500, "container request priority")
50 inputDir := flags.String("input-dir", "./in", "input `directory`")
51 outputDir := flags.String("output-dir", "./out", "output `directory`")
52 ref := flags.String("ref", "", "reference name (if blank, choose last one that appears in input)")
53 regionsFilename := flags.String("regions", "", "only output columns/annotations that intersect regions in specified bed `file`")
54 expandRegions := flags.Int("expand-regions", 0, "expand specified regions by `N` base pairs on each side`")
55 mergeOutput := flags.Bool("merge-output", false, "merge output into one matrix.npy and one matrix.annotations.csv")
56 hgvsSingle := flags.Bool("single-hgvs-matrix", false, "also generate hgvs-based matrix")
57 hgvsChunked := flags.Bool("chunked-hgvs-matrix", false, "also generate hgvs-based matrix per chromosome")
58 flags.IntVar(&cmd.threads, "threads", 16, "number of memory-hungry assembly threads")
59 cmd.filter.Flags(flags)
60 err = flags.Parse(args)
61 if err == flag.ErrHelp {
64 } else if err != nil {
70 log.Println(http.ListenAndServe(*pprof, nil))
75 runner := arvadosContainerRunner{
76 Name: "lightning slice-numpy",
77 Client: arvados.NewClientFromEnv(),
78 ProjectUUID: *projectUUID,
85 err = runner.TranslatePaths(inputDir, regionsFilename)
89 runner.Args = []string{"slice-numpy", "-local=true",
91 "-input-dir=" + *inputDir,
92 "-output-dir=/mnt/output",
93 "-threads=" + fmt.Sprintf("%d", cmd.threads),
94 "-regions=" + *regionsFilename,
95 "-expand-regions=" + fmt.Sprintf("%d", *expandRegions),
96 "-merge-output=" + fmt.Sprintf("%v", *mergeOutput),
97 "-single-hgvs-matrix=" + fmt.Sprintf("%v", *hgvsSingle),
98 "-chunked-hgvs-matrix=" + fmt.Sprintf("%v", *hgvsChunked),
100 runner.Args = append(runner.Args, cmd.filter.Args()...)
102 output, err = runner.Run()
106 fmt.Fprintln(stdout, output)
110 infiles, err := allGobFiles(*inputDir)
114 if len(infiles) == 0 {
115 err = fmt.Errorf("no input files found in %s", *inputDir)
118 sort.Strings(infiles)
121 var refseq map[string][]tileLibRef
122 var reftiledata = make(map[tileLibRef][]byte, 11000000)
123 in0, err := open(infiles[0])
128 matchGenome, err := regexp.Compile(cmd.filter.MatchGenome)
130 err = fmt.Errorf("-match-genome: invalid regexp: %q", cmd.filter.MatchGenome)
135 DecodeLibrary(in0, strings.HasSuffix(infiles[0], ".gz"), func(ent *LibraryEntry) error {
136 if len(ent.TagSet) > 0 {
137 taglen = len(ent.TagSet[0])
139 for _, cseq := range ent.CompactSequences {
140 if cseq.Name == *ref || *ref == "" {
141 refseq = cseq.TileSequences
144 for _, cg := range ent.CompactGenomes {
145 if matchGenome.MatchString(cg.Name) {
146 cgnames = append(cgnames, cg.Name)
149 for _, tv := range ent.TileVariants {
151 reftiledata[tileLibRef{tv.Tag, tv.Variant}] = tv.Sequence
161 err = fmt.Errorf("%s: reference sequence not found", infiles[0])
165 err = fmt.Errorf("tagset not found")
168 if len(cgnames) == 0 {
169 err = fmt.Errorf("no genomes found matching regexp %q", cmd.filter.MatchGenome)
172 sort.Strings(cgnames)
175 labelsFilename := *outputDir + "/labels.csv"
176 log.Infof("writing labels to %s", labelsFilename)
178 f, err = os.Create(labelsFilename)
183 for i, name := range cgnames {
184 _, err = fmt.Fprintf(f, "%d,%q\n", i, trimFilenameForLabel(name))
186 err = fmt.Errorf("write %s: %w", labelsFilename, err)
192 err = fmt.Errorf("close %s: %w", labelsFilename, err)
197 log.Info("indexing reference tiles")
198 type reftileinfo struct {
199 variant tileVariantID
200 seqname string // chr1
201 pos int // distance from start of chromosome to starttag
202 tiledata []byte // acgtggcaa...
204 isdup := map[tagID]bool{}
205 reftile := map[tagID]*reftileinfo{}
206 for seqname, cseq := range refseq {
208 for _, libref := range cseq {
209 tiledata := reftiledata[libref]
210 if len(tiledata) == 0 {
211 err = fmt.Errorf("missing tiledata for tag %d variant %d in %s in ref", libref.Tag, libref.Variant, seqname)
214 if isdup[libref.Tag] {
215 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique", libref, seqname, pos)
216 } else if reftile[libref.Tag] != nil {
217 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique", tileLibRef{Tag: libref.Tag, Variant: reftile[libref.Tag].variant}, reftile[libref.Tag].seqname, reftile[libref.Tag].pos)
218 delete(reftile, libref.Tag)
219 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique", libref, seqname, pos)
220 isdup[libref.Tag] = true
222 reftile[libref.Tag] = &reftileinfo{
224 variant: libref.Variant,
229 pos += len(tiledata) - taglen
231 log.Printf("... %s done, len %d", seqname, pos+taglen)
235 if *regionsFilename != "" {
236 log.Printf("loading regions from %s", *regionsFilename)
237 mask, err = makeMask(*regionsFilename, *expandRegions)
241 log.Printf("before applying mask, len(reftile) == %d", len(reftile))
242 log.Printf("deleting reftile entries for regions outside %d intervals", mask.Len())
243 for tag, rt := range reftile {
244 if !mask.Check(strings.TrimPrefix(rt.seqname, "chr"), rt.pos, rt.pos+len(rt.tiledata)) {
248 log.Printf("after applying mask, len(reftile) == %d", len(reftile))
251 tmpHGVSCols := map[string]*os.File{}
252 bufHGVSCols := map[string]*bufio.Writer{}
253 encodeHGVSCols := map[string]*gob.Encoder{}
255 for seqname := range refseq {
257 f, err = os.Create(*outputDir + "/tmp." + seqname + ".gob")
261 defer os.Remove(f.Name())
262 bufw := bufio.NewWriterSize(f, 1<<24)
263 enc := gob.NewEncoder(bufw)
264 tmpHGVSCols[seqname] = f
265 bufHGVSCols[seqname] = bufw
266 encodeHGVSCols[seqname] = enc
270 var toMerge [][]int16
271 if *mergeOutput || *hgvsSingle {
272 toMerge = make([][]int16, len(infiles))
275 throttleMem := throttle{Max: cmd.threads} // TODO: estimate using mem and data size
276 throttleNumpyMem := throttle{Max: cmd.threads/2 + 1}
277 log.Info("generating annotations and numpy matrix for each slice")
279 for infileIdx, infile := range infiles {
280 infileIdx, infile := infileIdx, infile
281 throttleMem.Go(func() error {
282 seq := make(map[tagID][]TileVariant, 50000)
283 cgs := make(map[string]CompactGenome, len(cgnames))
284 f, err := open(infile)
289 log.Infof("%04d: reading %s", infileIdx, infile)
290 err = DecodeLibrary(f, strings.HasSuffix(infile, ".gz"), func(ent *LibraryEntry) error {
291 for _, tv := range ent.TileVariants {
295 if mask != nil && reftile[tv.Tag] == nil {
301 variants := seq[tv.Tag]
302 if len(variants) == 0 {
303 variants = make([]TileVariant, 100)
305 for len(variants) <= int(tv.Variant) {
306 variants = append(variants, TileVariant{})
308 variants[int(tv.Variant)] = tv
309 seq[tv.Tag] = variants
311 for _, cg := range ent.CompactGenomes {
312 if !matchGenome.MatchString(cg.Name) {
315 // pad to full slice size
316 // to avoid out-of-bounds
318 if sliceSize := int(cg.EndTag - cg.StartTag); len(cg.Variants) < sliceSize {
319 cg.Variants = append(cg.Variants, make([]tileVariantID, sliceSize-len(cg.Variants))...)
328 tagstart := cgs[cgnames[0]].StartTag
329 tagend := cgs[cgnames[0]].EndTag
333 log.Infof("%04d: renumber/dedup variants for tags %d-%d", infileIdx, tagstart, tagend)
334 variantRemap := make([][]tileVariantID, tagend-tagstart)
335 throttleCPU := throttle{Max: runtime.GOMAXPROCS(0)}
336 for tag, variants := range seq {
337 tag, variants := tag, variants
338 throttleCPU.Acquire()
340 defer throttleCPU.Release()
341 count := make(map[[blake2b.Size256]byte]int, len(variants))
345 count[blake2b.Sum256(rt.tiledata)] = 0
348 for _, cg := range cgs {
349 idx := int(tag-tagstart) * 2
350 for allele := 0; allele < 2; allele++ {
351 v := cg.Variants[idx+allele]
352 if v > 0 && len(variants[v].Sequence) > 0 {
353 count[variants[v].Blake2b]++
357 // hash[i] will be the hash of
358 // the variant(s) that should
359 // be at rank i (0-based).
360 hash := make([][blake2b.Size256]byte, 0, len(count))
361 for b := range count {
362 hash = append(hash, b)
364 sort.Slice(hash, func(i, j int) bool {
365 bi, bj := &hash[i], &hash[j]
366 if ci, cj := count[*bi], count[*bj]; ci != cj {
369 return bytes.Compare((*bi)[:], (*bj)[:]) < 0
372 // rank[b] will be the 1-based
373 // new variant number for
374 // variants whose hash is b.
375 rank := make(map[[blake2b.Size256]byte]tileVariantID, len(hash))
376 for i, h := range hash {
377 rank[h] = tileVariantID(i + 1)
379 // remap[v] will be the new
380 // variant number for original
382 remap := make([]tileVariantID, len(variants))
383 for i, tv := range variants {
384 remap[i] = rank[tv.Blake2b]
386 variantRemap[tag-tagstart] = remap
388 rt.variant = rank[blake2b.Sum256(rt.tiledata)]
394 annotationsFilename := fmt.Sprintf("%s/matrix.%04d.annotations.csv", *outputDir, infileIdx)
395 log.Infof("%04d: writing %s", infileIdx, annotationsFilename)
396 annof, err := os.Create(annotationsFilename)
400 annow := bufio.NewWriterSize(annof, 1<<20)
402 for tag := tagstart; tag < tagend; tag++ {
403 rt, ok := reftile[tag]
408 // Excluded by specified
409 // regions, or reference does
410 // not use any variant of this
411 // tile. (TODO: log this?
412 // mention it in annotations?)
415 fmt.Fprintf(annow, "%d,%d,%d,=,%s,%d,,,\n", tag, outcol, rt.variant, rt.seqname, rt.pos)
417 reftilestr := strings.ToUpper(string(rt.tiledata))
418 remap := variantRemap[tag-tagstart]
419 maxv := tileVariantID(0)
420 for _, v := range remap {
425 done := make([]bool, maxv+1)
426 variantDiffs := make([][]hgvs.Variant, maxv+1)
427 for v, tv := range variants {
429 if v == rt.variant || done[v] {
434 if len(tv.Sequence) < taglen || !bytes.HasSuffix(rt.tiledata, tv.Sequence[len(tv.Sequence)-taglen:]) {
435 fmt.Fprintf(annow, "%d,%d,%d,,%s,%d,,,\n", tag, outcol, v, rt.seqname, rt.pos)
438 if lendiff := len(rt.tiledata) - len(tv.Sequence); lendiff < -1000 || lendiff > 1000 {
439 fmt.Fprintf(annow, "%d,%d,%d,,%s,%d,,,\n", tag, outcol, v, rt.seqname, rt.pos)
442 diffs, _ := hgvs.Diff(reftilestr, strings.ToUpper(string(tv.Sequence)), 0)
443 for _, diff := range diffs {
444 diff.Position += rt.pos
445 fmt.Fprintf(annow, "%d,%d,%d,%s:g.%s,%s,%d,%s,%s,%s\n", tag, outcol, v, rt.seqname, diff.String(), rt.seqname, diff.Position, diff.Ref, diff.New, diff.Left)
448 variantDiffs[v] = diffs
452 // We can now determine, for each HGVS
453 // variant (diff) in this reftile
454 // region, whether a given genome
455 // phase/allele (1) has the variant, (0) has
456 // =ref or a different variant in that
457 // position, or (-1) is lacking
458 // coverage / couldn't be diffed.
459 hgvsCol := map[hgvs.Variant][2][]int8{}
460 for _, diffs := range variantDiffs {
461 for _, diff := range diffs {
462 if _, ok := hgvsCol[diff]; ok {
465 hgvsCol[diff] = [2][]int8{
466 make([]int8, len(cgnames)),
467 make([]int8, len(cgnames)),
471 for row, name := range cgnames {
472 variants := cgs[name].Variants[(tag-tagstart)*2:]
473 for ph := 0; ph < 2; ph++ {
475 if int(v) >= len(remap) {
481 // hgvsCol[*][ph][row] is already 0
482 } else if len(variantDiffs[v]) == 0 {
483 // lacking coverage / couldn't be diffed
484 for _, col := range hgvsCol {
488 for _, diff := range variantDiffs[v] {
489 hgvsCol[diff][ph][row] = 1
494 encodeHGVSCols[rt.seqname].Encode(hgvsCol)
507 log.Infof("%04d: preparing numpy", infileIdx)
508 throttleNumpyMem.Acquire()
511 out := make([]int16, rows*cols)
512 for row, name := range cgnames {
513 out := out[row*cols:]
515 for col, v := range cgs[name].Variants {
516 tag := tagstart + tagID(col/2)
517 if mask != nil && reftile[tag] == nil {
520 if variants, ok := seq[tag]; ok && len(variants) > int(v) && len(variants[v].Sequence) > 0 {
521 out[outcol] = int16(variantRemap[tag-tagstart][v])
529 throttleNumpyMem.Release()
531 if *mergeOutput || *hgvsSingle {
532 log.Infof("%04d: matrix fragment %d rows x %d cols", infileIdx, rows, cols)
533 toMerge[infileIdx] = out
536 fnm := fmt.Sprintf("%s/matrix.%04d.npy", *outputDir, infileIdx)
537 err = writeNumpyInt16(fnm, out, rows, cols)
542 log.Infof("%s: done (%d/%d)", infile, int(atomic.AddInt64(&done, 1)), len(infiles))
546 if err = throttleMem.Wait(); err != nil {
551 log.Info("flushing hgvsCols temp files")
552 for seqname := range refseq {
553 err = bufHGVSCols[seqname].Flush()
557 bufHGVSCols[seqname] = nil // free buffer memory
559 for seqname := range refseq {
560 log.Infof("%s: reading hgvsCols from temp file", seqname)
561 f := tmpHGVSCols[seqname]
562 _, err = f.Seek(0, io.SeekStart)
566 var hgvsCols map[hgvs.Variant][2][]int8
567 dec := gob.NewDecoder(bufio.NewReaderSize(f, 1<<24))
569 err = dec.Decode(&hgvsCols)
574 log.Infof("%s: sorting %d hgvs variants", seqname, len(hgvsCols))
575 variants := make([]hgvs.Variant, 0, len(hgvsCols))
576 for v := range hgvsCols {
577 variants = append(variants, v)
579 sort.Slice(variants, func(i, j int) bool {
580 vi, vj := &variants[i], &variants[j]
581 if vi.Position != vj.Position {
582 return vi.Position < vj.Position
583 } else if vi.Ref != vj.Ref {
584 return vi.Ref < vj.Ref
586 return vi.New < vj.New
590 cols := len(variants) * 2
591 log.Infof("%s: building hgvs matrix (rows=%d, cols=%d, mem=%d)", seqname, rows, cols, rows*cols)
592 out := make([]int8, rows*cols)
593 for varIdx, variant := range variants {
594 hgvsCols := hgvsCols[variant]
595 for row := range cgnames {
596 for ph := 0; ph < 2; ph++ {
597 out[row*cols+varIdx+ph] = hgvsCols[ph][row]
601 err = writeNumpyInt8(fmt.Sprintf("%s/hgvs.%s.npy", *outputDir, seqname), out, rows, cols)
607 fnm := fmt.Sprintf("%s/hgvs.%s.annotations.csv", *outputDir, seqname)
608 log.Infof("%s: writing hgvs column labels to %s", seqname, fnm)
609 var hgvsLabels bytes.Buffer
610 for varIdx, variant := range variants {
611 fmt.Fprintf(&hgvsLabels, "%d,%s:g.%s\n", varIdx, seqname, variant.String())
613 err = ioutil.WriteFile(fnm, hgvsLabels.Bytes(), 0666)
620 if *mergeOutput || *hgvsSingle {
621 var annow *bufio.Writer
624 annoFilename := fmt.Sprintf("%s/matrix.annotations.csv", *outputDir)
625 annof, err = os.Create(annoFilename)
629 annow = bufio.NewWriterSize(annof, 1<<20)
634 for _, chunk := range toMerge {
635 cols += len(chunk) / rows
637 log.Infof("merging output matrix (rows=%d, cols=%d, mem=%d) and annotations", rows, cols, rows*cols*2)
640 out = make([]int16, rows*cols)
642 hgvsCols := map[string][2][]int16{} // hgvs -> [[g0,g1,g2,...], [g0,g1,g2,...]] (slice of genomes for each phase)
644 for outIdx, chunk := range toMerge {
645 chunkcols := len(chunk) / rows
647 for row := 0; row < rows; row++ {
648 copy(out[row*cols+startcol:], chunk[row*chunkcols:(row+1)*chunkcols])
651 toMerge[outIdx] = nil
653 annotationsFilename := fmt.Sprintf("%s/matrix.%04d.annotations.csv", *outputDir, outIdx)
654 log.Infof("reading %s", annotationsFilename)
655 buf, err := os.ReadFile(annotationsFilename)
660 err = os.Remove(annotationsFilename)
665 for _, line := range bytes.Split(buf, []byte{'\n'}) {
669 fields := bytes.SplitN(line, []byte{','}, 9)
670 tag, _ := strconv.Atoi(string(fields[0]))
671 incol, _ := strconv.Atoi(string(fields[1]))
672 tileVariant, _ := strconv.Atoi(string(fields[2]))
673 hgvsID := string(fields[3])
674 seqname := string(fields[4])
675 pos, _ := strconv.Atoi(string(fields[5]))
678 // Null entry for un-diffable
683 // Null entry for ref tile
686 if mask != nil && !mask.Check(strings.TrimPrefix(seqname, "chr"), pos, pos+len(refseq)) {
687 // The tile intersects one of
688 // the selected regions, but
689 // this particular HGVS
693 hgvsColPair := hgvsCols[hgvsID]
694 if hgvsColPair[0] == nil {
695 // values in new columns start
696 // out as -1 ("no data yet")
697 // or 0 ("=ref") here, may
698 // change to 1 ("hgvs variant
699 // present") below, either on
700 // this line or a future line.
701 hgvsColPair = [2][]int16{make([]int16, len(cgnames)), make([]int16, len(cgnames))}
702 rt, ok := reftile[tagID(tag)]
704 err = fmt.Errorf("bug: seeing annotations for tag %d, but it has no reftile entry", tag)
707 for ph := 0; ph < 2; ph++ {
708 for row := 0; row < rows; row++ {
709 v := chunk[row*chunkcols+incol*2+ph]
710 if tileVariantID(v) == rt.variant {
711 hgvsColPair[ph][row] = 0
713 hgvsColPair[ph][row] = -1
717 hgvsCols[hgvsID] = hgvsColPair
719 hgvsref := hgvs.Variant{
724 fmt.Fprintf(annow, "%d,%d,%d,%s:g.%s,%s,%d,%s,%s,%s\n", tag, incol+startcol/2, rt.variant, seqname, hgvsref.String(), seqname, pos, refseq, refseq, fields[8])
728 fmt.Fprintf(annow, "%d,%d,%d,%s,%s,%d,%s,%s,%s\n", tag, incol+startcol/2, tileVariant, hgvsID, seqname, pos, refseq, fields[7], fields[8])
730 for ph := 0; ph < 2; ph++ {
731 for row := 0; row < rows; row++ {
732 v := chunk[row*chunkcols+incol*2+ph]
733 if int(v) == tileVariant {
734 hgvsColPair[ph][row] = 1
740 startcol += chunkcols
751 err = writeNumpyInt16(fmt.Sprintf("%s/matrix.npy", *outputDir), out, rows, cols)
759 cols = len(hgvsCols) * 2
760 log.Printf("building hgvs-based matrix: %d rows x %d cols", rows, cols)
761 out = make([]int16, rows*cols)
762 hgvsIDs := make([]string, 0, cols/2)
763 for hgvsID := range hgvsCols {
764 hgvsIDs = append(hgvsIDs, hgvsID)
766 sort.Strings(hgvsIDs)
767 var hgvsLabels bytes.Buffer
768 for idx, hgvsID := range hgvsIDs {
769 fmt.Fprintf(&hgvsLabels, "%d,%s\n", idx, hgvsID)
770 for ph := 0; ph < 2; ph++ {
771 hgvscol := hgvsCols[hgvsID][ph]
772 for row, val := range hgvscol {
773 out[row*cols+idx*2+ph] = val
777 err = writeNumpyInt16(fmt.Sprintf("%s/hgvs.npy", *outputDir), out, rows, cols)
782 fnm := fmt.Sprintf("%s/hgvs.annotations.csv", *outputDir)
783 log.Printf("writing hgvs labels: %s", fnm)
784 err = ioutil.WriteFile(fnm, hgvsLabels.Bytes(), 0777)
793 func writeNumpyInt16(fnm string, out []int16, rows, cols int) error {
794 output, err := os.Create(fnm)
799 bufw := bufio.NewWriterSize(output, 1<<26)
800 npw, err := gonpy.NewWriter(nopCloser{bufw})
804 log.WithFields(log.Fields{
808 }).Infof("writing numpy: %s", fnm)
809 npw.Shape = []int{rows, cols}
815 return output.Close()
818 func writeNumpyInt8(fnm string, out []int8, rows, cols int) error {
819 output, err := os.Create(fnm)
824 bufw := bufio.NewWriterSize(output, 1<<26)
825 npw, err := gonpy.NewWriter(nopCloser{bufw})
829 log.WithFields(log.Fields{
833 }).Infof("writing numpy: %s", fnm)
834 npw.Shape = []int{rows, cols}
840 return output.Close()