1 // Copyright (C) The Lightning Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
24 "git.arvados.org/arvados.git/sdk/go/arvados"
25 "github.com/arvados/lightning/hgvs"
26 "github.com/kshedden/gonpy"
27 log "github.com/sirupsen/logrus"
28 "golang.org/x/crypto/blake2b"
31 type sliceNumpy struct {
36 func (cmd *sliceNumpy) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
40 fmt.Fprintf(stderr, "%s\n", err)
43 flags := flag.NewFlagSet("", flag.ContinueOnError)
44 flags.SetOutput(stderr)
45 pprof := flags.String("pprof", "", "serve Go profile data at http://`[addr]:port`")
46 runlocal := flags.Bool("local", false, "run on local host (default: run in an arvados container)")
47 projectUUID := flags.String("project", "", "project `UUID` for output data")
48 priority := flags.Int("priority", 500, "container request priority")
49 inputDir := flags.String("input-dir", "./in", "input `directory`")
50 outputDir := flags.String("output-dir", "./out", "output `directory`")
51 ref := flags.String("ref", "", "reference name (if blank, choose last one that appears in input)")
52 regionsFilename := flags.String("regions", "", "only output columns/annotations that intersect regions in specified bed `file`")
53 expandRegions := flags.Int("expand-regions", 0, "expand specified regions by `N` base pairs on each side`")
54 mergeOutput := flags.Bool("merge-output", false, "merge output into one matrix.npy and one matrix.annotations.csv")
55 hgvsSingle := flags.Bool("single-hgvs-matrix", false, "also generate hgvs-based matrix")
56 hgvsChunked := flags.Bool("chunked-hgvs-matrix", false, "also generate hgvs-based matrix per chromosome")
57 flags.IntVar(&cmd.threads, "threads", 16, "number of memory-hungry assembly threads")
58 cmd.filter.Flags(flags)
59 err = flags.Parse(args)
60 if err == flag.ErrHelp {
63 } else if err != nil {
69 log.Println(http.ListenAndServe(*pprof, nil))
74 runner := arvadosContainerRunner{
75 Name: "lightning slice-numpy",
76 Client: arvados.NewClientFromEnv(),
77 ProjectUUID: *projectUUID,
84 err = runner.TranslatePaths(inputDir, regionsFilename)
88 runner.Args = []string{"slice-numpy", "-local=true",
90 "-input-dir=" + *inputDir,
91 "-output-dir=/mnt/output",
92 "-threads=" + fmt.Sprintf("%d", cmd.threads),
93 "-regions=" + *regionsFilename,
94 "-expand-regions=" + fmt.Sprintf("%d", *expandRegions),
95 "-merge-output=" + fmt.Sprintf("%v", *mergeOutput),
96 "-single-hgvs-matrix=" + fmt.Sprintf("%v", *hgvsSingle),
97 "-chunked-hgvs-matrix=" + fmt.Sprintf("%v", *hgvsChunked),
99 runner.Args = append(runner.Args, cmd.filter.Args()...)
101 output, err = runner.Run()
105 fmt.Fprintln(stdout, output)
109 infiles, err := allGobFiles(*inputDir)
113 if len(infiles) == 0 {
114 err = fmt.Errorf("no input files found in %s", *inputDir)
117 sort.Strings(infiles)
120 var refseq map[string][]tileLibRef
121 var reftiledata = make(map[tileLibRef][]byte, 11000000)
122 in0, err := open(infiles[0])
127 matchGenome, err := regexp.Compile(cmd.filter.MatchGenome)
129 err = fmt.Errorf("-match-genome: invalid regexp: %q", cmd.filter.MatchGenome)
134 DecodeLibrary(in0, strings.HasSuffix(infiles[0], ".gz"), func(ent *LibraryEntry) error {
135 if len(ent.TagSet) > 0 {
136 taglen = len(ent.TagSet[0])
138 for _, cseq := range ent.CompactSequences {
139 if cseq.Name == *ref || *ref == "" {
140 refseq = cseq.TileSequences
143 for _, cg := range ent.CompactGenomes {
144 if matchGenome.MatchString(cg.Name) {
145 cgnames = append(cgnames, cg.Name)
148 for _, tv := range ent.TileVariants {
150 reftiledata[tileLibRef{tv.Tag, tv.Variant}] = tv.Sequence
160 err = fmt.Errorf("%s: reference sequence not found", infiles[0])
164 err = fmt.Errorf("tagset not found")
167 if len(cgnames) == 0 {
168 err = fmt.Errorf("no genomes found matching regexp %q", cmd.filter.MatchGenome)
171 sort.Strings(cgnames)
174 labelsFilename := *outputDir + "/labels.csv"
175 log.Infof("writing labels to %s", labelsFilename)
177 f, err = os.Create(labelsFilename)
182 for i, name := range cgnames {
183 _, err = fmt.Fprintf(f, "%d,%q\n", i, trimFilenameForLabel(name))
185 err = fmt.Errorf("write %s: %w", labelsFilename, err)
191 err = fmt.Errorf("close %s: %w", labelsFilename, err)
196 log.Info("indexing reference tiles")
197 type reftileinfo struct {
198 variant tileVariantID
199 seqname string // chr1
200 pos int // distance from start of chromosome to starttag
201 tiledata []byte // acgtggcaa...
203 isdup := map[tagID]bool{}
204 reftile := map[tagID]*reftileinfo{}
205 for seqname, cseq := range refseq {
207 for _, libref := range cseq {
208 tiledata := reftiledata[libref]
209 if len(tiledata) == 0 {
210 err = fmt.Errorf("missing tiledata for tag %d variant %d in %s in ref", libref.Tag, libref.Variant, seqname)
213 if isdup[libref.Tag] {
214 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique", libref, seqname, pos)
215 } else if reftile[libref.Tag] != nil {
216 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)
217 delete(reftile, libref.Tag)
218 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique", libref, seqname, pos)
219 isdup[libref.Tag] = true
221 reftile[libref.Tag] = &reftileinfo{
223 variant: libref.Variant,
228 pos += len(tiledata) - taglen
230 log.Printf("... %s done, len %d", seqname, pos+taglen)
234 if *regionsFilename != "" {
235 log.Printf("loading regions from %s", *regionsFilename)
236 mask, err = makeMask(*regionsFilename, *expandRegions)
240 log.Printf("before applying mask, len(reftile) == %d", len(reftile))
241 log.Printf("deleting reftile entries for regions outside %d intervals", mask.Len())
242 for tag, rt := range reftile {
243 if !mask.Check(strings.TrimPrefix(rt.seqname, "chr"), rt.pos, rt.pos+len(rt.tiledata)) {
247 log.Printf("after applying mask, len(reftile) == %d", len(reftile))
250 var toMerge [][]int16
251 if *mergeOutput || *hgvsSingle || *hgvsChunked {
252 toMerge = make([][]int16, len(infiles))
255 throttleMem := throttle{Max: cmd.threads} // TODO: estimate using mem and data size
256 throttleNumpyMem := throttle{Max: cmd.threads/2 + 1}
257 log.Info("generating annotations and numpy matrix for each slice")
259 for infileIdx, infile := range infiles {
260 infileIdx, infile := infileIdx, infile
261 throttleMem.Go(func() error {
262 seq := make(map[tagID][]TileVariant, 50000)
263 cgs := make(map[string]CompactGenome, len(cgnames))
264 f, err := open(infile)
269 log.Infof("%04d: reading %s", infileIdx, infile)
270 err = DecodeLibrary(f, strings.HasSuffix(infile, ".gz"), func(ent *LibraryEntry) error {
271 for _, tv := range ent.TileVariants {
275 if mask != nil && reftile[tv.Tag] == nil {
281 variants := seq[tv.Tag]
282 if len(variants) == 0 {
283 variants = make([]TileVariant, 100)
285 for len(variants) <= int(tv.Variant) {
286 variants = append(variants, TileVariant{})
288 variants[int(tv.Variant)] = tv
289 seq[tv.Tag] = variants
291 for _, cg := range ent.CompactGenomes {
292 if matchGenome.MatchString(cg.Name) {
301 tagstart := cgs[cgnames[0]].StartTag
302 tagend := cgs[cgnames[0]].EndTag
306 log.Infof("%04d: renumber/dedup variants for tags %d-%d", infileIdx, tagstart, tagend)
307 variantRemap := make([][]tileVariantID, tagend-tagstart)
308 throttleCPU := throttle{Max: runtime.GOMAXPROCS(0)}
309 for tag, variants := range seq {
310 tag, variants := tag, variants
311 throttleCPU.Acquire()
313 defer throttleCPU.Release()
314 count := make(map[[blake2b.Size256]byte]int, len(variants))
318 count[blake2b.Sum256(rt.tiledata)] = 0
321 for _, cg := range cgs {
322 idx := int(tag-tagstart) * 2
323 if idx < len(cg.Variants) {
324 for allele := 0; allele < 2; allele++ {
325 v := cg.Variants[idx+allele]
326 if v > 0 && len(variants[v].Sequence) > 0 {
327 count[variants[v].Blake2b]++
332 // hash[i] will be the hash of
333 // the variant(s) that should
334 // be at rank i (0-based).
335 hash := make([][blake2b.Size256]byte, 0, len(count))
336 for b := range count {
337 hash = append(hash, b)
339 sort.Slice(hash, func(i, j int) bool {
340 bi, bj := &hash[i], &hash[j]
341 if ci, cj := count[*bi], count[*bj]; ci != cj {
344 return bytes.Compare((*bi)[:], (*bj)[:]) < 0
347 // rank[b] will be the 1-based
348 // new variant number for
349 // variants whose hash is b.
350 rank := make(map[[blake2b.Size256]byte]tileVariantID, len(hash))
351 for i, h := range hash {
352 rank[h] = tileVariantID(i + 1)
354 // remap[v] will be the new
355 // variant number for original
357 remap := make([]tileVariantID, len(variants))
358 for i, tv := range variants {
359 remap[i] = rank[tv.Blake2b]
361 variantRemap[tag-tagstart] = remap
363 rt.variant = rank[blake2b.Sum256(rt.tiledata)]
369 annotationsFilename := fmt.Sprintf("%s/matrix.%04d.annotations.csv", *outputDir, infileIdx)
370 log.Infof("%04d: writing %s", infileIdx, annotationsFilename)
371 annof, err := os.Create(annotationsFilename)
375 annow := bufio.NewWriterSize(annof, 1<<20)
377 for tag := tagstart; tag < tagend; tag++ {
378 rt, ok := reftile[tag]
383 // Excluded by specified
384 // regions, or reference does
385 // not use any variant of this
386 // tile. (TODO: log this?
387 // mention it in annotations?)
390 fmt.Fprintf(annow, "%d,%d,%d,=,%s,%d,,,\n", tag, outcol, rt.variant, rt.seqname, rt.pos)
392 reftilestr := strings.ToUpper(string(rt.tiledata))
393 remap := variantRemap[tag-tagstart]
394 done := make([]bool, len(variants))
395 for v, tv := range variants {
397 if v == rt.variant || done[v] {
402 if len(tv.Sequence) < taglen || !bytes.HasSuffix(rt.tiledata, tv.Sequence[len(tv.Sequence)-taglen:]) {
403 fmt.Fprintf(annow, "%d,%d,%d,,%s,%d,,,\n", tag, outcol, v, rt.seqname, rt.pos)
406 if lendiff := len(rt.tiledata) - len(tv.Sequence); lendiff < -1000 || lendiff > 1000 {
407 fmt.Fprintf(annow, "%d,%d,%d,,%s,%d,,,\n", tag, outcol, v, rt.seqname, rt.pos)
410 diffs, _ := hgvs.Diff(reftilestr, strings.ToUpper(string(tv.Sequence)), 0)
411 for _, diff := range diffs {
412 diff.Position += rt.pos
413 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)
427 log.Infof("%04d: preparing numpy", infileIdx)
428 throttleNumpyMem.Acquire()
431 out := make([]int16, rows*cols)
432 for row, name := range cgnames {
433 out := out[row*cols:]
435 for col, v := range cgs[name].Variants {
436 tag := tagstart + tagID(col/2)
437 if mask != nil && reftile[tag] == nil {
440 if variants, ok := seq[tag]; ok && len(variants) > int(v) && len(variants[v].Sequence) > 0 {
441 out[outcol] = int16(variantRemap[tag-tagstart][v])
449 throttleNumpyMem.Release()
451 if *mergeOutput || *hgvsSingle || *hgvsChunked {
452 log.Infof("%04d: matrix fragment %d rows x %d cols", infileIdx, rows, cols)
453 toMerge[infileIdx] = out
456 fnm := fmt.Sprintf("%s/matrix.%04d.npy", *outputDir, infileIdx)
457 err = writeNumpyInt16(fnm, out, rows, cols)
462 log.Infof("%s: done (%d/%d)", infile, int(atomic.AddInt64(&done, 1)), len(infiles))
466 if err = throttleMem.Wait(); err != nil {
469 if *mergeOutput || *hgvsSingle || *hgvsChunked {
470 var annow *bufio.Writer
473 annoFilename := fmt.Sprintf("%s/matrix.annotations.csv", *outputDir)
474 annof, err = os.Create(annoFilename)
478 annow = bufio.NewWriterSize(annof, 1<<20)
483 for _, chunk := range toMerge {
484 cols += len(chunk) / rows
486 log.Infof("merging output matrix (rows=%d, cols=%d, mem=%d) and annotations", rows, cols, rows*cols*2)
489 out = make([]int16, rows*cols)
491 hgvsCols := map[string][2][]int16{} // hgvs -> [[g0,g1,g2,...], [g0,g1,g2,...]] (slice of genomes for each phase)
493 for outIdx, chunk := range toMerge {
494 chunkcols := len(chunk) / rows
496 for row := 0; row < rows; row++ {
497 copy(out[row*cols+startcol:], chunk[row*chunkcols:(row+1)*chunkcols])
500 toMerge[outIdx] = nil
502 annotationsFilename := fmt.Sprintf("%s/matrix.%04d.annotations.csv", *outputDir, outIdx)
503 log.Infof("reading %s", annotationsFilename)
504 buf, err := os.ReadFile(annotationsFilename)
509 err = os.Remove(annotationsFilename)
514 for _, line := range bytes.Split(buf, []byte{'\n'}) {
518 fields := bytes.SplitN(line, []byte{','}, 9)
519 tag, _ := strconv.Atoi(string(fields[0]))
520 incol, _ := strconv.Atoi(string(fields[1]))
521 tileVariant, _ := strconv.Atoi(string(fields[2]))
522 hgvsID := string(fields[3])
523 seqname := string(fields[4])
524 pos, _ := strconv.Atoi(string(fields[5]))
527 // Null entry for un-diffable
532 // Null entry for ref tile
535 if mask != nil && !mask.Check(strings.TrimPrefix(seqname, "chr"), pos, pos+len(refseq)) {
536 // The tile intersects one of
537 // the selected regions, but
538 // this particular HGVS
542 hgvsColPair := hgvsCols[hgvsID]
543 if hgvsColPair[0] == nil {
544 // values in new columns start
545 // out as -1 ("no data yet")
546 // or 0 ("=ref") here, may
547 // change to 1 ("hgvs variant
548 // present") below, either on
549 // this line or a future line.
550 hgvsColPair = [2][]int16{make([]int16, len(cgnames)), make([]int16, len(cgnames))}
551 rt, ok := reftile[tagID(tag)]
553 err = fmt.Errorf("bug: seeing annotations for tag %d, but it has no reftile entry", tag)
556 for ph := 0; ph < 2; ph++ {
557 for row := 0; row < rows; row++ {
558 v := chunk[row*chunkcols+incol*2+ph]
559 if tileVariantID(v) == rt.variant {
560 hgvsColPair[ph][row] = 0
562 hgvsColPair[ph][row] = -1
566 hgvsCols[hgvsID] = hgvsColPair
567 hgvsref := hgvs.Variant{
573 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])
577 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])
579 for ph := 0; ph < 2; ph++ {
580 for row := 0; row < rows; row++ {
581 v := chunk[row*chunkcols+incol*2+ph]
582 if int(v) == tileVariant {
583 hgvsColPair[ph][row] = 1
589 startcol += chunkcols
600 err = writeNumpyInt16(fmt.Sprintf("%s/matrix.npy", *outputDir), out, rows, cols)
607 var seqnames []string
609 seqnames = []string{""}
612 for seqname := range refseq {
613 seqnames = append(seqnames, seqname)
616 for _, seqname := range seqnames {
620 cols = len(hgvsCols) * 2
622 basename = "hgvs." + seqname
623 wantPrefix = seqname + ":"
625 for hgvsID := range hgvsCols {
626 if strings.HasPrefix(hgvsID, wantPrefix) {
631 log.Printf("building hgvs-based matrix [%s]: %d rows x %d cols", seqname, rows, cols)
632 out = make([]int16, rows*cols)
633 hgvsIDs := make([]string, 0, cols/2)
634 for hgvsID := range hgvsCols {
635 if strings.HasPrefix(hgvsID, wantPrefix) {
636 hgvsIDs = append(hgvsIDs, hgvsID)
639 sort.Strings(hgvsIDs)
640 var hgvsLabels bytes.Buffer
641 for idx, hgvsID := range hgvsIDs {
642 fmt.Fprintf(&hgvsLabels, "%d,%s\n", idx, hgvsID)
643 for ph := 0; ph < 2; ph++ {
644 hgvscol := hgvsCols[hgvsID][ph]
645 for row, val := range hgvscol {
646 out[row*cols+idx*2+ph] = val
650 err = writeNumpyInt16(fmt.Sprintf("%s/%s.npy", *outputDir, basename), out, rows, cols)
655 fnm := fmt.Sprintf("%s/%s.annotations.csv", *outputDir, basename)
656 log.Printf("writing hgvs labels: %s", fnm)
657 err = ioutil.WriteFile(fnm, hgvsLabels.Bytes(), 0777)
666 func writeNumpyInt16(fnm string, out []int16, rows, cols int) error {
667 output, err := os.Create(fnm)
672 bufw := bufio.NewWriterSize(output, 1<<26)
673 npw, err := gonpy.NewWriter(nopCloser{bufw})
677 log.WithFields(log.Fields{
681 }).Infof("writing numpy: %s", fnm)
682 npw.Shape = []int{rows, cols}
688 return output.Close()