1 // Copyright (C) The Lightning Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
29 "git.arvados.org/arvados.git/sdk/go/arvados"
30 "github.com/arvados/lightning/hgvs"
31 "github.com/kshedden/gonpy"
32 "github.com/sirupsen/logrus"
33 log "github.com/sirupsen/logrus"
34 "golang.org/x/crypto/blake2b"
37 type sliceNumpy struct {
40 chi2CaseControlColumn string
41 chi2CaseControlFile string
50 func (cmd *sliceNumpy) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
54 fmt.Fprintf(stderr, "%s\n", err)
57 flags := flag.NewFlagSet("", flag.ContinueOnError)
58 flags.SetOutput(stderr)
59 pprof := flags.String("pprof", "", "serve Go profile data at http://`[addr]:port`")
60 runlocal := flags.Bool("local", false, "run on local host (default: run in an arvados container)")
61 projectUUID := flags.String("project", "", "project `UUID` for output data")
62 priority := flags.Int("priority", 500, "container request priority")
63 inputDir := flags.String("input-dir", "./in", "input `directory`")
64 outputDir := flags.String("output-dir", "./out", "output `directory`")
65 ref := flags.String("ref", "", "reference name (if blank, choose last one that appears in input)")
66 regionsFilename := flags.String("regions", "", "only output columns/annotations that intersect regions in specified bed `file`")
67 expandRegions := flags.Int("expand-regions", 0, "expand specified regions by `N` base pairs on each side`")
68 mergeOutput := flags.Bool("merge-output", false, "merge output into one matrix.npy and one matrix.annotations.csv")
69 hgvsSingle := flags.Bool("single-hgvs-matrix", false, "also generate hgvs-based matrix")
70 hgvsChunked := flags.Bool("chunked-hgvs-matrix", false, "also generate hgvs-based matrix per chromosome")
71 onehotSingle := flags.Bool("single-onehot", false, "generate one-hot tile-based matrix")
72 onehotChunked := flags.Bool("chunked-onehot", false, "generate one-hot tile-based matrix per input chunk")
73 debugTag := flags.Int("debug-tag", -1, "log debugging details about specified tag")
74 flags.IntVar(&cmd.threads, "threads", 16, "number of memory-hungry assembly threads")
75 flags.StringVar(&cmd.chi2CaseControlFile, "chi2-case-control-file", "", "tsv file or directory indicating cases and controls for Χ² test (if directory, all .tsv files will be read)")
76 flags.StringVar(&cmd.chi2CaseControlColumn, "chi2-case-control-column", "", "name of case/control column in case-control files for Χ² test (value must be 0 for control, 1 for case)")
77 flags.Float64Var(&cmd.chi2PValue, "chi2-p-value", 1, "do Χ² test and omit columns with p-value above this threshold")
78 flags.BoolVar(&cmd.includeVariant1, "include-variant-1", false, "include most common variant when building one-hot matrix")
79 cmd.filter.Flags(flags)
80 err = flags.Parse(args)
81 if err == flag.ErrHelp {
84 } else if err != nil {
90 log.Println(http.ListenAndServe(*pprof, nil))
94 if cmd.chi2PValue != 1 && (cmd.chi2CaseControlFile == "" || cmd.chi2CaseControlColumn == "") {
95 log.Errorf("cannot use provided -chi2-p-value=%f because -chi2-case-control-file= or -chi2-case-control-column= value is empty", cmd.chi2PValue)
99 cmd.debugTag = tagID(*debugTag)
102 runner := arvadosContainerRunner{
103 Name: "lightning slice-numpy",
104 Client: arvados.NewClientFromEnv(),
105 ProjectUUID: *projectUUID,
112 err = runner.TranslatePaths(inputDir, regionsFilename, &cmd.chi2CaseControlFile)
116 runner.Args = []string{"slice-numpy", "-local=true",
118 "-input-dir=" + *inputDir,
119 "-output-dir=/mnt/output",
120 "-threads=" + fmt.Sprintf("%d", cmd.threads),
121 "-regions=" + *regionsFilename,
122 "-expand-regions=" + fmt.Sprintf("%d", *expandRegions),
123 "-merge-output=" + fmt.Sprintf("%v", *mergeOutput),
124 "-single-hgvs-matrix=" + fmt.Sprintf("%v", *hgvsSingle),
125 "-chunked-hgvs-matrix=" + fmt.Sprintf("%v", *hgvsChunked),
126 "-single-onehot=" + fmt.Sprintf("%v", *onehotSingle),
127 "-chunked-onehot=" + fmt.Sprintf("%v", *onehotChunked),
128 "-chi2-case-control-file=" + cmd.chi2CaseControlFile,
129 "-chi2-case-control-column=" + cmd.chi2CaseControlColumn,
130 "-chi2-p-value=" + fmt.Sprintf("%f", cmd.chi2PValue),
131 "-include-variant-1=" + fmt.Sprintf("%v", cmd.includeVariant1),
132 "-debug-tag=" + fmt.Sprintf("%d", cmd.debugTag),
134 runner.Args = append(runner.Args, cmd.filter.Args()...)
136 output, err = runner.Run()
140 fmt.Fprintln(stdout, output)
144 infiles, err := allFiles(*inputDir, matchGobFile)
148 if len(infiles) == 0 {
149 err = fmt.Errorf("no input files found in %s", *inputDir)
152 sort.Strings(infiles)
154 var refseq map[string][]tileLibRef
155 var reftiledata = make(map[tileLibRef][]byte, 11000000)
156 in0, err := open(infiles[0])
161 matchGenome, err := regexp.Compile(cmd.filter.MatchGenome)
163 err = fmt.Errorf("-match-genome: invalid regexp: %q", cmd.filter.MatchGenome)
169 err = DecodeLibrary(in0, strings.HasSuffix(infiles[0], ".gz"), func(ent *LibraryEntry) error {
170 if len(ent.TagSet) > 0 {
173 for _, cseq := range ent.CompactSequences {
174 if cseq.Name == *ref || *ref == "" {
175 refseq = cseq.TileSequences
178 for _, cg := range ent.CompactGenomes {
179 if matchGenome.MatchString(cg.Name) {
180 cmd.cgnames = append(cmd.cgnames, cg.Name)
183 for _, tv := range ent.TileVariants {
185 reftiledata[tileLibRef{tv.Tag, tv.Variant}] = tv.Sequence
195 err = fmt.Errorf("%s: reference sequence not found", infiles[0])
198 if len(tagset) == 0 {
199 err = fmt.Errorf("tagset not found")
203 taglib := &tagLibrary{}
204 err = taglib.setTags(tagset)
208 taglen := taglib.TagLen()
210 if len(cmd.cgnames) == 0 {
211 err = fmt.Errorf("no genomes found matching regexp %q", cmd.filter.MatchGenome)
214 sort.Strings(cmd.cgnames)
215 err = cmd.useCaseControlFiles()
219 cmd.minCoverage = int(math.Ceil(cmd.filter.MinCoverage * float64(len(cmd.cgnames))))
222 labelsFilename := *outputDir + "/samples.csv"
223 log.Infof("writing labels to %s", labelsFilename)
225 f, err = os.Create(labelsFilename)
230 for i, name := range cmd.cgnames {
232 if cmd.chi2Cases != nil && cmd.chi2Cases[i] {
235 _, err = fmt.Fprintf(f, "%d,%q,%d\n", i, trimFilenameForLabel(name), cc)
237 err = fmt.Errorf("write %s: %w", labelsFilename, err)
243 err = fmt.Errorf("close %s: %w", labelsFilename, err)
248 log.Info("indexing reference tiles")
249 type reftileinfo struct {
250 variant tileVariantID
251 seqname string // chr1
252 pos int // distance from start of chromosome to starttag
253 tiledata []byte // acgtggcaa...
255 isdup := map[tagID]bool{}
256 reftile := map[tagID]*reftileinfo{}
257 for seqname, cseq := range refseq {
259 for _, libref := range cseq {
260 if cmd.filter.MaxTag >= 0 && libref.Tag > tagID(cmd.filter.MaxTag) {
263 tiledata := reftiledata[libref]
264 if len(tiledata) == 0 {
265 err = fmt.Errorf("missing tiledata for tag %d variant %d in %s in ref", libref.Tag, libref.Variant, seqname)
268 foundthistag := false
269 taglib.FindAll(tiledata[:len(tiledata)-1], func(tagid tagID, offset, _ int) {
270 if !foundthistag && tagid == libref.Tag {
274 if dupref, ok := reftile[tagid]; ok {
275 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique, also found inside %+v from %s @ %d", tileLibRef{Tag: tagid, Variant: dupref.variant}, dupref.seqname, dupref.pos, libref, seqname, pos+offset+1)
276 delete(reftile, tagid)
278 log.Printf("found tag %d at offset %d inside tile variant %+v on %s @ %d", tagid, offset, libref, seqname, pos+offset+1)
282 if isdup[libref.Tag] {
283 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique", libref, seqname, pos)
284 } else if reftile[libref.Tag] != nil {
285 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)
286 delete(reftile, libref.Tag)
287 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique", libref, seqname, pos)
288 isdup[libref.Tag] = true
290 reftile[libref.Tag] = &reftileinfo{
292 variant: libref.Variant,
297 pos += len(tiledata) - taglen
299 log.Printf("... %s done, len %d", seqname, pos+taglen)
303 if *regionsFilename != "" {
304 log.Printf("loading regions from %s", *regionsFilename)
305 mask, err = makeMask(*regionsFilename, *expandRegions)
309 log.Printf("before applying mask, len(reftile) == %d", len(reftile))
310 log.Printf("deleting reftile entries for regions outside %d intervals", mask.Len())
311 for tag, rt := range reftile {
312 if !mask.Check(strings.TrimPrefix(rt.seqname, "chr"), rt.pos, rt.pos+len(rt.tiledata)) {
316 log.Printf("after applying mask, len(reftile) == %d", len(reftile))
319 type hgvsColSet map[hgvs.Variant][2][]int8
320 encodeHGVS := throttle{Max: len(refseq)}
321 encodeHGVSTodo := map[string]chan hgvsColSet{}
322 tmpHGVSCols := map[string]*os.File{}
324 for seqname := range refseq {
326 f, err = os.Create(*outputDir + "/tmp." + seqname + ".gob")
330 defer os.Remove(f.Name())
331 bufw := bufio.NewWriterSize(f, 1<<24)
332 enc := gob.NewEncoder(bufw)
333 tmpHGVSCols[seqname] = f
334 todo := make(chan hgvsColSet, 128)
335 encodeHGVSTodo[seqname] = todo
336 encodeHGVS.Go(func() error {
337 for colset := range todo {
338 err := enc.Encode(colset)
340 encodeHGVS.Report(err)
351 var toMerge [][]int16
352 if *mergeOutput || *hgvsSingle {
353 toMerge = make([][]int16, len(infiles))
355 var onehotIndirect [][2][]uint32 // [chunkIndex][axis][index]
356 var onehotChunkSize []uint32
357 var onehotXrefs [][]onehotXref
359 onehotIndirect = make([][2][]uint32, len(infiles))
360 onehotChunkSize = make([]uint32, len(infiles))
361 onehotXrefs = make([][]onehotXref, len(infiles))
363 chunkStartTag := make([]tagID, len(infiles))
365 throttleMem := throttle{Max: cmd.threads} // TODO: estimate using mem and data size
366 throttleNumpyMem := throttle{Max: cmd.threads/2 + 1}
367 log.Info("generating annotations and numpy matrix for each slice")
368 var errSkip = errors.New("skip infile")
370 for infileIdx, infile := range infiles {
371 infileIdx, infile := infileIdx, infile
372 throttleMem.Go(func() error {
373 seq := make(map[tagID][]TileVariant, 50000)
374 cgs := make(map[string]CompactGenome, len(cmd.cgnames))
375 f, err := open(infile)
380 log.Infof("%04d: reading %s", infileIdx, infile)
381 err = DecodeLibrary(f, strings.HasSuffix(infile, ".gz"), func(ent *LibraryEntry) error {
382 for _, tv := range ent.TileVariants {
386 if mask != nil && reftile[tv.Tag] == nil {
392 if tv.Tag == cmd.debugTag {
393 log.Printf("infile %d %s tag %d variant %d hash %x", infileIdx, infile, tv.Tag, tv.Variant, tv.Blake2b[:3])
395 variants := seq[tv.Tag]
396 if len(variants) == 0 {
397 variants = make([]TileVariant, 100)
399 for len(variants) <= int(tv.Variant) {
400 variants = append(variants, TileVariant{})
402 variants[int(tv.Variant)] = tv
403 seq[tv.Tag] = variants
405 for _, cg := range ent.CompactGenomes {
406 if cmd.filter.MaxTag >= 0 && cg.StartTag > tagID(cmd.filter.MaxTag) {
409 if !matchGenome.MatchString(cg.Name) {
412 // pad to full slice size
413 // to avoid out-of-bounds
415 if sliceSize := 2 * int(cg.EndTag-cg.StartTag); len(cg.Variants) < sliceSize {
416 cg.Variants = append(cg.Variants, make([]tileVariantID, sliceSize-len(cg.Variants))...)
424 } else if err != nil {
427 tagstart := cgs[cmd.cgnames[0]].StartTag
428 tagend := cgs[cmd.cgnames[0]].EndTag
429 chunkStartTag[infileIdx] = tagstart
433 log.Infof("%04d: renumber/dedup variants for tags %d-%d", infileIdx, tagstart, tagend)
434 variantRemap := make([][]tileVariantID, tagend-tagstart)
435 throttleCPU := throttle{Max: runtime.GOMAXPROCS(0)}
436 for tag, variants := range seq {
437 tag, variants := tag, variants
438 throttleCPU.Go(func() error {
439 count := make(map[[blake2b.Size256]byte]int, len(variants))
443 count[blake2b.Sum256(rt.tiledata)] = 0
446 for cgname, cg := range cgs {
447 idx := int(tag-tagstart) * 2
448 for allele := 0; allele < 2; allele++ {
449 v := cg.Variants[idx+allele]
450 if v > 0 && len(variants[v].Sequence) > 0 {
451 count[variants[v].Blake2b]++
453 if v > 0 && tag == cmd.debugTag {
454 log.Printf("tag %d cg %s allele %d tv %d hash %x count is now %d", tag, cgname, allele, v, variants[v].Blake2b[:3], count[variants[v].Blake2b])
458 // hash[i] will be the hash of
459 // the variant(s) that should
460 // be at rank i (0-based).
461 hash := make([][blake2b.Size256]byte, 0, len(count))
462 for b := range count {
463 hash = append(hash, b)
465 sort.Slice(hash, func(i, j int) bool {
466 bi, bj := &hash[i], &hash[j]
467 if ci, cj := count[*bi], count[*bj]; ci != cj {
470 return bytes.Compare((*bi)[:], (*bj)[:]) < 0
473 // rank[b] will be the 1-based
474 // new variant number for
475 // variants whose hash is b.
476 rank := make(map[[blake2b.Size256]byte]tileVariantID, len(hash))
477 for i, h := range hash {
478 rank[h] = tileVariantID(i + 1)
480 if tag == cmd.debugTag {
481 for h, r := range rank {
482 log.Printf("tag %d rank(%x) = %v", tag, h[:3], r)
485 // remap[v] will be the new
486 // variant number for original
488 remap := make([]tileVariantID, len(variants))
489 for i, tv := range variants {
490 remap[i] = rank[tv.Blake2b]
492 if tag == cmd.debugTag {
493 for in, out := range remap {
495 log.Printf("tag %d remap %d => %d", tag, in, out)
499 variantRemap[tag-tagstart] = remap
501 refrank := rank[blake2b.Sum256(rt.tiledata)]
502 if tag == cmd.debugTag {
503 log.Printf("tag %d reftile variant %d => %d", tag, rt.variant, refrank)
512 var onehotChunk [][]int8
513 var onehotXref []onehotXref
515 annotationsFilename := fmt.Sprintf("%s/matrix.%04d.annotations.csv", *outputDir, infileIdx)
516 log.Infof("%04d: writing %s", infileIdx, annotationsFilename)
517 annof, err := os.Create(annotationsFilename)
521 annow := bufio.NewWriterSize(annof, 1<<20)
523 for tag := tagstart; tag < tagend; tag++ {
525 if rt == nil && mask != nil {
526 // Excluded by specified regions
529 if cmd.filter.MaxTag >= 0 && tag > tagID(cmd.filter.MaxTag) {
532 remap := variantRemap[tag-tagstart]
533 maxv := tileVariantID(0)
534 for _, v := range remap {
539 if *onehotChunked || *onehotSingle {
540 onehot, xrefs := cmd.tv2homhet(cgs, maxv, remap, tag, tagstart)
541 if tag == cmd.debugTag {
542 log.WithFields(logrus.Fields{
545 }).Info("tv2homhet()")
547 onehotChunk = append(onehotChunk, onehot...)
548 onehotXref = append(onehotXref, xrefs...)
551 // Reference does not use any
552 // variant of this tile
556 fmt.Fprintf(annow, "%d,%d,%d,=,%s,%d,,,\n", tag, outcol, rt.variant, rt.seqname, rt.pos)
558 reftilestr := strings.ToUpper(string(rt.tiledata))
560 done := make([]bool, maxv+1)
561 variantDiffs := make([][]hgvs.Variant, maxv+1)
562 for v, tv := range variants {
564 if v == rt.variant || done[v] {
569 if len(tv.Sequence) < taglen || !bytes.HasSuffix(rt.tiledata, tv.Sequence[len(tv.Sequence)-taglen:]) {
570 fmt.Fprintf(annow, "%d,%d,%d,,%s,%d,,,\n", tag, outcol, v, rt.seqname, rt.pos)
573 if lendiff := len(rt.tiledata) - len(tv.Sequence); lendiff < -1000 || lendiff > 1000 {
574 fmt.Fprintf(annow, "%d,%d,%d,,%s,%d,,,\n", tag, outcol, v, rt.seqname, rt.pos)
577 diffs, _ := hgvs.Diff(reftilestr, strings.ToUpper(string(tv.Sequence)), 0)
578 for i := range diffs {
579 diffs[i].Position += rt.pos
581 for _, diff := range diffs {
582 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)
585 variantDiffs[v] = diffs
589 // We can now determine, for each HGVS
590 // variant (diff) in this reftile
591 // region, whether a given genome
592 // phase/allele (1) has the variant, (0) has
593 // =ref or a different variant in that
594 // position, or (-1) is lacking
595 // coverage / couldn't be diffed.
596 hgvsCol := hgvsColSet{}
597 for _, diffs := range variantDiffs {
598 for _, diff := range diffs {
599 if _, ok := hgvsCol[diff]; ok {
602 hgvsCol[diff] = [2][]int8{
603 make([]int8, len(cmd.cgnames)),
604 make([]int8, len(cmd.cgnames)),
608 for row, name := range cmd.cgnames {
609 variants := cgs[name].Variants[(tag-tagstart)*2:]
610 for ph := 0; ph < 2; ph++ {
612 if int(v) >= len(remap) {
618 // hgvsCol[*][ph][row] is already 0
619 } else if len(variantDiffs[v]) == 0 {
620 // lacking coverage / couldn't be diffed
621 for _, col := range hgvsCol {
625 for _, diff := range variantDiffs[v] {
626 hgvsCol[diff][ph][row] = 1
631 for diff, colpair := range hgvsCol {
632 allele2homhet(colpair)
633 if !cmd.filterHGVScolpair(colpair) {
634 delete(hgvsCol, diff)
637 if len(hgvsCol) > 0 {
638 encodeHGVSTodo[rt.seqname] <- hgvsCol
653 // transpose onehotChunk[col][row] to numpy[row*ncols+col]
654 rows := len(cmd.cgnames)
655 cols := len(onehotChunk)
656 log.Infof("%04d: preparing onehot numpy (rows=%d, cols=%d, mem=%d)", infileIdx, rows, cols, rows*cols)
657 throttleNumpyMem.Acquire()
658 out := onehotcols2int8(onehotChunk)
659 fnm := fmt.Sprintf("%s/onehot.%04d.npy", *outputDir, infileIdx)
660 err = writeNumpyInt8(fnm, out, rows, cols)
664 fnm = fmt.Sprintf("%s/onehot-columns.%04d.npy", *outputDir, infileIdx)
665 err = writeNumpyInt32(fnm, onehotXref2int32(onehotXref), 4, len(onehotXref))
670 throttleNumpyMem.Release()
673 onehotIndirect[infileIdx] = onehotChunk2Indirect(onehotChunk)
674 onehotChunkSize[infileIdx] = uint32(len(onehotChunk))
675 onehotXrefs[infileIdx] = onehotXref
676 n := len(onehotIndirect[infileIdx][0])
677 log.Infof("%04d: keeping onehot coordinates in memory (n=%d, mem=%d)", infileIdx, n, n*8*2)
679 if !(*onehotSingle || *onehotChunked) || *mergeOutput || *hgvsSingle {
680 log.Infof("%04d: preparing numpy (rows=%d, cols=%d)", infileIdx, len(cmd.cgnames), 2*outcol)
681 throttleNumpyMem.Acquire()
682 rows := len(cmd.cgnames)
684 out := make([]int16, rows*cols)
685 for row, name := range cmd.cgnames {
687 for col, v := range cgs[name].Variants {
688 tag := tagstart + tagID(col/2)
689 if cmd.filter.MaxTag >= 0 && tag > tagID(cmd.filter.MaxTag) {
692 if mask != nil && reftile[tag] == nil {
696 out[outidx] = 0 // tag not found / spanning tile
697 } else if variants, ok := seq[tag]; ok && int(v) < len(variants) && len(variants[v].Sequence) > 0 {
698 out[outidx] = int16(variantRemap[tag-tagstart][v])
700 out[outidx] = -1 // low quality tile variant
702 if tag == cmd.debugTag {
703 log.Printf("tag %d row %d col %d outidx %d v %d out %d", tag, row, col, outidx, v, out[outidx])
711 throttleNumpyMem.Release()
712 if *mergeOutput || *hgvsSingle {
713 log.Infof("%04d: matrix fragment %d rows x %d cols", infileIdx, rows, cols)
714 toMerge[infileIdx] = out
716 if !*mergeOutput && !*onehotChunked && !*onehotSingle {
717 fnm := fmt.Sprintf("%s/matrix.%04d.npy", *outputDir, infileIdx)
718 err = writeNumpyInt16(fnm, out, rows, cols)
725 log.Infof("%s: done (%d/%d)", infile, int(atomic.AddInt64(&done, 1)), len(infiles))
729 if err = throttleMem.Wait(); err != nil {
734 log.Info("flushing hgvsCols temp files")
735 for seqname := range refseq {
736 close(encodeHGVSTodo[seqname])
738 err = encodeHGVS.Wait()
742 for seqname := range refseq {
743 log.Infof("%s: reading hgvsCols from temp file", seqname)
744 f := tmpHGVSCols[seqname]
745 _, err = f.Seek(0, io.SeekStart)
749 var hgvsCols hgvsColSet
750 dec := gob.NewDecoder(bufio.NewReaderSize(f, 1<<24))
752 err = dec.Decode(&hgvsCols)
757 log.Infof("%s: sorting %d hgvs variants", seqname, len(hgvsCols))
758 variants := make([]hgvs.Variant, 0, len(hgvsCols))
759 for v := range hgvsCols {
760 variants = append(variants, v)
762 sort.Slice(variants, func(i, j int) bool {
763 vi, vj := &variants[i], &variants[j]
764 if vi.Position != vj.Position {
765 return vi.Position < vj.Position
766 } else if vi.Ref != vj.Ref {
767 return vi.Ref < vj.Ref
769 return vi.New < vj.New
772 rows := len(cmd.cgnames)
773 cols := len(variants) * 2
774 log.Infof("%s: building hgvs matrix (rows=%d, cols=%d, mem=%d)", seqname, rows, cols, rows*cols)
775 out := make([]int8, rows*cols)
776 for varIdx, variant := range variants {
777 hgvsCols := hgvsCols[variant]
778 for row := range cmd.cgnames {
779 for ph := 0; ph < 2; ph++ {
780 out[row*cols+varIdx+ph] = hgvsCols[ph][row]
784 err = writeNumpyInt8(fmt.Sprintf("%s/hgvs.%s.npy", *outputDir, seqname), out, rows, cols)
790 fnm := fmt.Sprintf("%s/hgvs.%s.annotations.csv", *outputDir, seqname)
791 log.Infof("%s: writing hgvs column labels to %s", seqname, fnm)
792 var hgvsLabels bytes.Buffer
793 for varIdx, variant := range variants {
794 fmt.Fprintf(&hgvsLabels, "%d,%s:g.%s\n", varIdx, seqname, variant.String())
796 err = ioutil.WriteFile(fnm, hgvsLabels.Bytes(), 0666)
803 if *mergeOutput || *hgvsSingle {
804 var annow *bufio.Writer
807 annoFilename := fmt.Sprintf("%s/matrix.annotations.csv", *outputDir)
808 annof, err = os.Create(annoFilename)
812 annow = bufio.NewWriterSize(annof, 1<<20)
815 rows := len(cmd.cgnames)
817 for _, chunk := range toMerge {
818 cols += len(chunk) / rows
820 log.Infof("merging output matrix (rows=%d, cols=%d, mem=%d) and annotations", rows, cols, rows*cols*2)
823 out = make([]int16, rows*cols)
825 hgvsCols := map[string][2][]int16{} // hgvs -> [[g0,g1,g2,...], [g0,g1,g2,...]] (slice of genomes for each phase)
827 for outIdx, chunk := range toMerge {
828 chunkcols := len(chunk) / rows
830 for row := 0; row < rows; row++ {
831 copy(out[row*cols+startcol:], chunk[row*chunkcols:(row+1)*chunkcols])
834 toMerge[outIdx] = nil
836 annotationsFilename := fmt.Sprintf("%s/matrix.%04d.annotations.csv", *outputDir, outIdx)
837 log.Infof("reading %s", annotationsFilename)
838 buf, err := os.ReadFile(annotationsFilename)
843 err = os.Remove(annotationsFilename)
848 for _, line := range bytes.Split(buf, []byte{'\n'}) {
852 fields := bytes.SplitN(line, []byte{','}, 9)
853 tag, _ := strconv.Atoi(string(fields[0]))
854 incol, _ := strconv.Atoi(string(fields[1]))
855 tileVariant, _ := strconv.Atoi(string(fields[2]))
856 hgvsID := string(fields[3])
857 seqname := string(fields[4])
858 pos, _ := strconv.Atoi(string(fields[5]))
861 // Null entry for un-diffable
866 // Null entry for ref tile
869 if mask != nil && !mask.Check(strings.TrimPrefix(seqname, "chr"), pos, pos+len(refseq)) {
870 // The tile intersects one of
871 // the selected regions, but
872 // this particular HGVS
876 hgvsColPair := hgvsCols[hgvsID]
877 if hgvsColPair[0] == nil {
878 // values in new columns start
879 // out as -1 ("no data yet")
880 // or 0 ("=ref") here, may
881 // change to 1 ("hgvs variant
882 // present") below, either on
883 // this line or a future line.
884 hgvsColPair = [2][]int16{make([]int16, len(cmd.cgnames)), make([]int16, len(cmd.cgnames))}
885 rt, ok := reftile[tagID(tag)]
887 err = fmt.Errorf("bug: seeing annotations for tag %d, but it has no reftile entry", tag)
890 for ph := 0; ph < 2; ph++ {
891 for row := 0; row < rows; row++ {
892 v := chunk[row*chunkcols+incol*2+ph]
893 if tileVariantID(v) == rt.variant {
894 hgvsColPair[ph][row] = 0
896 hgvsColPair[ph][row] = -1
900 hgvsCols[hgvsID] = hgvsColPair
902 hgvsref := hgvs.Variant{
907 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])
911 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])
913 for ph := 0; ph < 2; ph++ {
914 for row := 0; row < rows; row++ {
915 v := chunk[row*chunkcols+incol*2+ph]
916 if int(v) == tileVariant {
917 hgvsColPair[ph][row] = 1
923 startcol += chunkcols
934 err = writeNumpyInt16(fmt.Sprintf("%s/matrix.npy", *outputDir), out, rows, cols)
942 cols = len(hgvsCols) * 2
943 log.Printf("building hgvs-based matrix: %d rows x %d cols", rows, cols)
944 out = make([]int16, rows*cols)
945 hgvsIDs := make([]string, 0, cols/2)
946 for hgvsID := range hgvsCols {
947 hgvsIDs = append(hgvsIDs, hgvsID)
949 sort.Strings(hgvsIDs)
950 var hgvsLabels bytes.Buffer
951 for idx, hgvsID := range hgvsIDs {
952 fmt.Fprintf(&hgvsLabels, "%d,%s\n", idx, hgvsID)
953 for ph := 0; ph < 2; ph++ {
954 hgvscol := hgvsCols[hgvsID][ph]
955 for row, val := range hgvscol {
956 out[row*cols+idx*2+ph] = val
960 err = writeNumpyInt16(fmt.Sprintf("%s/hgvs.npy", *outputDir), out, rows, cols)
965 fnm := fmt.Sprintf("%s/hgvs.annotations.csv", *outputDir)
966 log.Printf("writing hgvs labels: %s", fnm)
967 err = ioutil.WriteFile(fnm, hgvsLabels.Bytes(), 0777)
975 for _, part := range onehotIndirect {
976 nzCount += len(part[0])
978 onehot := make([]uint32, nzCount*2) // [r,r,r,...,c,c,c,...]
979 var xrefs []onehotXref
980 chunkOffset := uint32(0)
982 for i, part := range onehotIndirect {
983 for i := range part[1] {
984 part[1][i] += chunkOffset
986 copy(onehot[outcol:], part[0])
987 copy(onehot[outcol+nzCount:], part[1])
988 xrefs = append(xrefs, onehotXrefs[i]...)
990 outcol += len(part[0])
991 chunkOffset += onehotChunkSize[i]
998 fnm := fmt.Sprintf("%s/onehot.npy", *outputDir)
999 err = writeNumpyUint32(fnm, onehot, 2, nzCount)
1003 fnm = fmt.Sprintf("%s/onehot-columns.npy", *outputDir)
1004 err = writeNumpyInt32(fnm, onehotXref2int32(xrefs), 5, len(xrefs))
1009 if !*mergeOutput && !*onehotChunked && !*onehotSingle {
1010 tagoffsetFilename := *outputDir + "/chunk-tag-offset.csv"
1011 log.Infof("writing tag offsets to %s", tagoffsetFilename)
1013 f, err = os.Create(tagoffsetFilename)
1018 for idx, offset := range chunkStartTag {
1019 _, err = fmt.Fprintf(f, "%q,%d\n", fmt.Sprintf("matrix.%04d.npy", idx), offset)
1021 err = fmt.Errorf("write %s: %w", tagoffsetFilename, err)
1027 err = fmt.Errorf("close %s: %w", tagoffsetFilename, err)
1034 // Read case/control files, remove non-case/control entries from
1035 // cmd.cgnames, and build cmd.chi2Cases.
1036 func (cmd *sliceNumpy) useCaseControlFiles() error {
1037 if cmd.chi2CaseControlFile == "" {
1040 infiles, err := allFiles(cmd.chi2CaseControlFile, nil)
1044 // index in cmd.cgnames => case(true) / control(false)
1045 cc := map[int]bool{}
1046 for _, infile := range infiles {
1047 f, err := open(infile)
1051 buf, err := io.ReadAll(f)
1057 for _, tsv := range bytes.Split(buf, []byte{'\n'}) {
1061 split := strings.Split(string(tsv), "\t")
1064 for col, name := range split {
1065 if name == cmd.chi2CaseControlColumn {
1071 return fmt.Errorf("%s: no column named %q in header row %q", infile, cmd.chi2CaseControlColumn, tsv)
1075 if len(split) <= ccCol {
1080 for i, name := range cmd.cgnames {
1081 if strings.Contains(name, pattern) {
1083 log.Warnf("pattern %q in %s matches multiple genome IDs (%qs, %q)", pattern, infile, cmd.cgnames[found], name)
1089 log.Warnf("pattern %q in %s does not match any genome IDs", pattern, infile)
1092 if split[ccCol] == "0" {
1095 if split[ccCol] == "1" {
1100 allnames := cmd.cgnames
1104 for i, name := range allnames {
1105 if cc, ok := cc[i]; ok {
1106 cmd.cgnames = append(cmd.cgnames, name)
1107 cmd.chi2Cases = append(cmd.chi2Cases, cc)
1113 log.Printf("%d cases, %d controls, %d neither (dropped)", ncases, len(cmd.cgnames)-ncases, len(allnames)-len(cmd.cgnames))
1117 func (cmd *sliceNumpy) filterHGVScolpair(colpair [2][]int8) bool {
1118 if cmd.chi2PValue >= 1 {
1121 col0 := make([]bool, 0, len(cmd.chi2Cases))
1122 col1 := make([]bool, 0, len(cmd.chi2Cases))
1123 cases := make([]bool, 0, len(cmd.chi2Cases))
1124 for i, c := range cmd.chi2Cases {
1125 if colpair[0][i] < 0 {
1128 col0 = append(col0, colpair[0][i] != 0)
1129 col1 = append(col1, colpair[1][i] != 0)
1130 cases = append(cases, c)
1132 return len(cases) >= cmd.minCoverage &&
1133 (pvalue(col0, cases) <= cmd.chi2PValue || pvalue(col1, cases) <= cmd.chi2PValue)
1136 func writeNumpyUint32(fnm string, out []uint32, rows, cols int) error {
1137 output, err := os.Create(fnm)
1141 defer output.Close()
1142 bufw := bufio.NewWriterSize(output, 1<<26)
1143 npw, err := gonpy.NewWriter(nopCloser{bufw})
1147 log.WithFields(log.Fields{
1151 "bytes": rows * cols * 4,
1152 }).Infof("writing numpy: %s", fnm)
1153 npw.Shape = []int{rows, cols}
1154 npw.WriteUint32(out)
1159 return output.Close()
1162 func writeNumpyInt32(fnm string, out []int32, rows, cols int) error {
1163 output, err := os.Create(fnm)
1167 defer output.Close()
1168 bufw := bufio.NewWriterSize(output, 1<<26)
1169 npw, err := gonpy.NewWriter(nopCloser{bufw})
1173 log.WithFields(log.Fields{
1177 "bytes": rows * cols * 4,
1178 }).Infof("writing numpy: %s", fnm)
1179 npw.Shape = []int{rows, cols}
1185 return output.Close()
1188 func writeNumpyInt16(fnm string, out []int16, rows, cols int) error {
1189 output, err := os.Create(fnm)
1193 defer output.Close()
1194 bufw := bufio.NewWriterSize(output, 1<<26)
1195 npw, err := gonpy.NewWriter(nopCloser{bufw})
1199 log.WithFields(log.Fields{
1203 "bytes": rows * cols * 2,
1204 }).Infof("writing numpy: %s", fnm)
1205 npw.Shape = []int{rows, cols}
1211 return output.Close()
1214 func writeNumpyInt8(fnm string, out []int8, rows, cols int) error {
1215 output, err := os.Create(fnm)
1219 defer output.Close()
1220 bufw := bufio.NewWriterSize(output, 1<<26)
1221 npw, err := gonpy.NewWriter(nopCloser{bufw})
1225 log.WithFields(log.Fields{
1229 "bytes": rows * cols,
1230 }).Infof("writing numpy: %s", fnm)
1231 npw.Shape = []int{rows, cols}
1237 return output.Close()
1240 func allele2homhet(colpair [2][]int8) {
1241 a, b := colpair[0], colpair[1]
1242 for i, av := range a {
1244 if av < 0 || bv < 0 {
1247 } else if av > 0 && bv > 0 {
1250 } else if av > 0 || bv > 0 {
1254 // ref (or a different variant in same position)
1255 // (this is a no-op) a[i], b[i] = 0, 0
1260 type onehotXref struct {
1262 variant tileVariantID
1267 const onehotXrefSize = unsafe.Sizeof(onehotXref{})
1269 // Build onehot matrix (m[tileVariantIndex][genome] == 0 or 1) for all
1270 // variants of a single tile/tag#.
1272 // Return nil if no tile variant passes Χ² filter.
1273 func (cmd *sliceNumpy) tv2homhet(cgs map[string]CompactGenome, maxv tileVariantID, remap []tileVariantID, tag, chunkstarttag tagID) ([][]int8, []onehotXref) {
1274 if tag == cmd.debugTag {
1275 tv := make([]tileVariantID, len(cmd.cgnames)*2)
1276 for i, name := range cmd.cgnames {
1277 copy(tv[i*2:(i+1)*2], cgs[name].Variants[(tag-chunkstarttag)*2:])
1279 log.WithFields(logrus.Fields{
1280 "cgs[i].Variants[tag*2+j]": tv,
1284 "chunkstarttag": chunkstarttag,
1285 }).Info("tv2homhet()")
1287 if maxv < 1 || (maxv < 2 && !cmd.includeVariant1) {
1288 // everyone has the most common variant (of the variants we don't drop)
1291 tagoffset := tag - chunkstarttag
1293 for _, cg := range cgs {
1294 if cg.Variants[tagoffset*2] > 0 && cg.Variants[tagoffset*2+1] > 0 {
1298 if coverage < cmd.minCoverage {
1301 obs := make([][]bool, (maxv+1)*2) // 2 slices (hom + het) for each variant#
1302 for i := range obs {
1303 obs[i] = make([]bool, len(cmd.cgnames))
1305 for cgid, name := range cmd.cgnames {
1306 cgvars := cgs[name].Variants[tagoffset*2:]
1307 tv0, tv1 := remap[cgvars[0]], remap[cgvars[1]]
1308 for v := tileVariantID(1); v <= maxv; v++ {
1309 if tv0 == v && tv1 == v {
1310 obs[v*2][cgid] = true
1311 } else if tv0 == v || tv1 == v {
1312 obs[v*2+1][cgid] = true
1317 var xref []onehotXref
1318 for col := 2; col < len(obs); col++ {
1319 // col 0,1 correspond to tile variant 0, i.e.,
1320 // no-call; col 2,3 correspond to the most common
1321 // variant; so we (normally) start at col 4.
1322 if col < 4 && !cmd.includeVariant1 {
1325 p := pvalue(obs[col], cmd.chi2Cases)
1326 if cmd.chi2PValue < 1 && !(p < cmd.chi2PValue) {
1329 onehot = append(onehot, bool2int8(obs[col]))
1330 xref = append(xref, onehotXref{
1332 variant: tileVariantID(col >> 1),
1340 func bool2int8(in []bool) []int8 {
1341 out := make([]int8, len(in))
1342 for i, v := range in {
1350 // convert a []onehotXref with length N to a numpy-style []int32
1351 // matrix with N columns, one row per field of onehotXref struct.
1353 // Hom/het row contains hom=0, het=1.
1355 // P-value row contains 1000000x actual p-value.
1356 func onehotXref2int32(xrefs []onehotXref) []int32 {
1358 xdata := make([]int32, 5*xcols)
1359 for i, xref := range xrefs {
1360 xdata[i] = int32(xref.tag)
1361 xdata[xcols+i] = int32(xref.variant)
1363 xdata[xcols*2+i] = 1
1365 xdata[xcols*3+i] = int32(xref.pvalue * 1000000)
1366 xdata[xcols*4+i] = int32(-math.Log10(xref.pvalue) * 1000000)
1371 // transpose onehot data from in[col][row] to numpy-style
1372 // out[row*cols+col].
1373 func onehotcols2int8(in [][]int8) []int8 {
1379 out := make([]int8, rows*cols)
1380 for row := 0; row < rows; row++ {
1381 outrow := out[row*cols:]
1382 for col, incol := range in {
1383 outrow[col] = incol[row]
1389 // Return [2][]uint32{rowIndices, colIndices} indicating which
1390 // elements of matrixT[c][r] have non-zero values.
1391 func onehotChunk2Indirect(matrixT [][]int8) [2][]uint32 {
1393 for c, col := range matrixT {
1394 for r, val := range col {
1396 nz[0] = append(nz[0], uint32(r))
1397 nz[1] = append(nz[1], uint32(c))