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/james-bowman/nlp"
32 "github.com/kshedden/gonpy"
33 "github.com/sirupsen/logrus"
34 log "github.com/sirupsen/logrus"
35 "golang.org/x/crypto/blake2b"
36 "gonum.org/v1/gonum/mat"
39 const annotationMaxTileSpan = 100
41 type sliceNumpy struct {
44 chi2CaseControlColumn string
45 chi2CaseControlFile string
54 func (cmd *sliceNumpy) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
55 err := cmd.run(prog, args, stdin, stdout, stderr)
57 fmt.Fprintf(stderr, "%s\n", err)
62 func (cmd *sliceNumpy) run(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) error {
63 flags := flag.NewFlagSet("", flag.ContinueOnError)
64 flags.SetOutput(stderr)
65 pprof := flags.String("pprof", "", "serve Go profile data at http://`[addr]:port`")
66 runlocal := flags.Bool("local", false, "run on local host (default: run in an arvados container)")
67 projectUUID := flags.String("project", "", "project `UUID` for output data")
68 priority := flags.Int("priority", 500, "container request priority")
69 inputDir := flags.String("input-dir", "./in", "input `directory`")
70 outputDir := flags.String("output-dir", "./out", "output `directory`")
71 ref := flags.String("ref", "", "reference name (if blank, choose last one that appears in input)")
72 regionsFilename := flags.String("regions", "", "only output columns/annotations that intersect regions in specified bed `file`")
73 expandRegions := flags.Int("expand-regions", 0, "expand specified regions by `N` base pairs on each side`")
74 mergeOutput := flags.Bool("merge-output", false, "merge output into one matrix.npy and one matrix.annotations.csv")
75 hgvsSingle := flags.Bool("single-hgvs-matrix", false, "also generate hgvs-based matrix")
76 hgvsChunked := flags.Bool("chunked-hgvs-matrix", false, "also generate hgvs-based matrix per chromosome")
77 onehotSingle := flags.Bool("single-onehot", false, "generate one-hot tile-based matrix")
78 onehotChunked := flags.Bool("chunked-onehot", false, "generate one-hot tile-based matrix per input chunk")
79 onlyPCA := flags.Bool("pca", false, "generate pca matrix")
80 pcaComponents := flags.Int("pca-components", 4, "number of PCA components")
81 debugTag := flags.Int("debug-tag", -1, "log debugging details about specified tag")
82 flags.IntVar(&cmd.threads, "threads", 16, "number of memory-hungry assembly threads")
83 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)")
84 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)")
85 flags.Float64Var(&cmd.chi2PValue, "chi2-p-value", 1, "do Χ² test and omit columns with p-value above this threshold")
86 flags.BoolVar(&cmd.includeVariant1, "include-variant-1", false, "include most common variant when building one-hot matrix")
87 cmd.filter.Flags(flags)
88 err := flags.Parse(args)
89 if err == flag.ErrHelp {
91 } else if err != nil {
97 log.Println(http.ListenAndServe(*pprof, nil))
101 if cmd.chi2PValue != 1 && (cmd.chi2CaseControlFile == "" || cmd.chi2CaseControlColumn == "") {
102 return fmt.Errorf("cannot use provided -chi2-p-value=%f because -chi2-case-control-file= or -chi2-case-control-column= value is empty", cmd.chi2PValue)
105 cmd.debugTag = tagID(*debugTag)
108 runner := arvadosContainerRunner{
109 Name: "lightning slice-numpy",
110 Client: arvados.NewClientFromEnv(),
111 ProjectUUID: *projectUUID,
118 err = runner.TranslatePaths(inputDir, regionsFilename, &cmd.chi2CaseControlFile)
122 runner.Args = []string{"slice-numpy", "-local=true",
124 "-input-dir=" + *inputDir,
125 "-output-dir=/mnt/output",
126 "-threads=" + fmt.Sprintf("%d", cmd.threads),
127 "-regions=" + *regionsFilename,
128 "-expand-regions=" + fmt.Sprintf("%d", *expandRegions),
129 "-merge-output=" + fmt.Sprintf("%v", *mergeOutput),
130 "-single-hgvs-matrix=" + fmt.Sprintf("%v", *hgvsSingle),
131 "-chunked-hgvs-matrix=" + fmt.Sprintf("%v", *hgvsChunked),
132 "-single-onehot=" + fmt.Sprintf("%v", *onehotSingle),
133 "-chunked-onehot=" + fmt.Sprintf("%v", *onehotChunked),
134 "-pca=" + fmt.Sprintf("%v", *onlyPCA),
135 "-chi2-case-control-file=" + cmd.chi2CaseControlFile,
136 "-chi2-case-control-column=" + cmd.chi2CaseControlColumn,
137 "-chi2-p-value=" + fmt.Sprintf("%f", cmd.chi2PValue),
138 "-include-variant-1=" + fmt.Sprintf("%v", cmd.includeVariant1),
139 "-debug-tag=" + fmt.Sprintf("%d", cmd.debugTag),
141 runner.Args = append(runner.Args, cmd.filter.Args()...)
143 output, err = runner.Run()
147 fmt.Fprintln(stdout, output)
151 infiles, err := allFiles(*inputDir, matchGobFile)
155 if len(infiles) == 0 {
156 err = fmt.Errorf("no input files found in %s", *inputDir)
159 sort.Strings(infiles)
161 var refseq map[string][]tileLibRef
162 var reftiledata = make(map[tileLibRef][]byte, 11000000)
163 in0, err := open(infiles[0])
168 matchGenome, err := regexp.Compile(cmd.filter.MatchGenome)
170 err = fmt.Errorf("-match-genome: invalid regexp: %q", cmd.filter.MatchGenome)
176 err = DecodeLibrary(in0, strings.HasSuffix(infiles[0], ".gz"), func(ent *LibraryEntry) error {
177 if len(ent.TagSet) > 0 {
180 for _, cseq := range ent.CompactSequences {
181 if cseq.Name == *ref || *ref == "" {
182 refseq = cseq.TileSequences
185 for _, cg := range ent.CompactGenomes {
186 if matchGenome.MatchString(cg.Name) {
187 cmd.cgnames = append(cmd.cgnames, cg.Name)
190 for _, tv := range ent.TileVariants {
192 reftiledata[tileLibRef{tv.Tag, tv.Variant}] = tv.Sequence
202 err = fmt.Errorf("%s: reference sequence not found", infiles[0])
205 if len(tagset) == 0 {
206 err = fmt.Errorf("tagset not found")
210 taglib := &tagLibrary{}
211 err = taglib.setTags(tagset)
215 taglen := taglib.TagLen()
217 if len(cmd.cgnames) == 0 {
218 err = fmt.Errorf("no genomes found matching regexp %q", cmd.filter.MatchGenome)
221 sort.Strings(cmd.cgnames)
222 err = cmd.useCaseControlFiles()
226 if len(cmd.cgnames) == 0 {
227 err = fmt.Errorf("fatal: 0 cases, 0 controls, nothing to do")
230 if cmd.filter.MinCoverage == 1 {
231 // In the generic formula below, floating point
232 // arithmetic can effectively push the coverage
233 // threshold above 1.0, which is impossible/useless.
234 // 1.0 needs to mean exactly 100% coverage.
235 cmd.minCoverage = len(cmd.cgnames)
237 cmd.minCoverage = int(math.Ceil(cmd.filter.MinCoverage * float64(len(cmd.cgnames))))
241 labelsFilename := *outputDir + "/samples.csv"
242 log.Infof("writing labels to %s", labelsFilename)
244 f, err = os.Create(labelsFilename)
249 for i, name := range cmd.cgnames {
251 if cmd.chi2Cases != nil && cmd.chi2Cases[i] {
254 _, err = fmt.Fprintf(f, "%d,%q,%d\n", i, trimFilenameForLabel(name), cc)
256 err = fmt.Errorf("write %s: %w", labelsFilename, err)
262 err = fmt.Errorf("close %s: %w", labelsFilename, err)
267 log.Info("indexing reference tiles")
268 type reftileinfo struct {
269 variant tileVariantID
270 seqname string // chr1
271 pos int // distance from start of chromosome to starttag
272 tiledata []byte // acgtggcaa...
273 excluded bool // true if excluded by regions file
274 nexttag tagID // tagID of following tile (-1 for last tag of chromosome)
276 isdup := map[tagID]bool{}
277 reftile := map[tagID]*reftileinfo{}
278 for seqname, cseq := range refseq {
280 lastreftag := tagID(-1)
281 for _, libref := range cseq {
282 if cmd.filter.MaxTag >= 0 && libref.Tag > tagID(cmd.filter.MaxTag) {
285 tiledata := reftiledata[libref]
286 if len(tiledata) == 0 {
287 err = fmt.Errorf("missing tiledata for tag %d variant %d in %s in ref", libref.Tag, libref.Variant, seqname)
290 foundthistag := false
291 taglib.FindAll(tiledata[:len(tiledata)-1], func(tagid tagID, offset, _ int) {
292 if !foundthistag && tagid == libref.Tag {
296 if dupref, ok := reftile[tagid]; ok {
297 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)
298 delete(reftile, tagid)
300 log.Printf("found tag %d at offset %d inside tile variant %+v on %s @ %d", tagid, offset, libref, seqname, pos+offset+1)
304 if isdup[libref.Tag] {
305 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique", libref, seqname, pos)
306 } else if reftile[libref.Tag] != nil {
307 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)
308 delete(reftile, libref.Tag)
309 log.Printf("dropping reference tile %+v from %s @ %d, tag not unique", libref, seqname, pos)
310 isdup[libref.Tag] = true
312 reftile[libref.Tag] = &reftileinfo{
314 variant: libref.Variant,
320 reftile[lastreftag].nexttag = libref.Tag
322 lastreftag = libref.Tag
324 pos += len(tiledata) - taglen
326 log.Printf("... %s done, len %d", seqname, pos+taglen)
330 if *regionsFilename != "" {
331 log.Printf("loading regions from %s", *regionsFilename)
332 mask, err = makeMask(*regionsFilename, *expandRegions)
336 log.Printf("before applying mask, len(reftile) == %d", len(reftile))
337 log.Printf("deleting reftile entries for regions outside %d intervals", mask.Len())
338 for _, rt := range reftile {
339 if !mask.Check(strings.TrimPrefix(rt.seqname, "chr"), rt.pos, rt.pos+len(rt.tiledata)) {
343 log.Printf("after applying mask, len(reftile) == %d", len(reftile))
346 type hgvsColSet map[hgvs.Variant][2][]int8
347 encodeHGVS := throttle{Max: len(refseq)}
348 encodeHGVSTodo := map[string]chan hgvsColSet{}
349 tmpHGVSCols := map[string]*os.File{}
351 for seqname := range refseq {
353 f, err = os.Create(*outputDir + "/tmp." + seqname + ".gob")
357 defer os.Remove(f.Name())
358 bufw := bufio.NewWriterSize(f, 1<<24)
359 enc := gob.NewEncoder(bufw)
360 tmpHGVSCols[seqname] = f
361 todo := make(chan hgvsColSet, 128)
362 encodeHGVSTodo[seqname] = todo
363 encodeHGVS.Go(func() error {
364 for colset := range todo {
365 err := enc.Encode(colset)
367 encodeHGVS.Report(err)
378 var toMerge [][]int16
379 if *mergeOutput || *hgvsSingle {
380 toMerge = make([][]int16, len(infiles))
382 var onehotIndirect [][2][]uint32 // [chunkIndex][axis][index]
383 var onehotChunkSize []uint32
384 var onehotXrefs [][]onehotXref
385 if *onehotSingle || *onlyPCA {
386 onehotIndirect = make([][2][]uint32, len(infiles))
387 onehotChunkSize = make([]uint32, len(infiles))
388 onehotXrefs = make([][]onehotXref, len(infiles))
390 chunkStartTag := make([]tagID, len(infiles))
392 throttleMem := throttle{Max: cmd.threads} // TODO: estimate using mem and data size
393 throttleNumpyMem := throttle{Max: cmd.threads/2 + 1}
394 log.Info("generating annotations and numpy matrix for each slice")
395 var errSkip = errors.New("skip infile")
397 for infileIdx, infile := range infiles {
398 infileIdx, infile := infileIdx, infile
399 throttleMem.Go(func() error {
400 seq := make(map[tagID][]TileVariant, 50000)
401 cgs := make(map[string]CompactGenome, len(cmd.cgnames))
402 f, err := open(infile)
407 log.Infof("%04d: reading %s", infileIdx, infile)
408 err = DecodeLibrary(f, strings.HasSuffix(infile, ".gz"), func(ent *LibraryEntry) error {
409 for _, tv := range ent.TileVariants {
414 // corresponding ref tile, if
415 // mask is in play (we can't
416 // determine coordinates for
418 if mask != nil && reftile[tv.Tag] == nil {
422 // corresponding ref tile is
423 // outside target regions --
424 // unless it's a potential
426 if mask != nil && reftile[tv.Tag].excluded &&
427 (int(tv.Tag+1) >= len(tagset) ||
428 (bytes.HasSuffix(tv.Sequence, tagset[tv.Tag+1]) && reftile[tv.Tag+1] != nil && !reftile[tv.Tag+1].excluded)) {
431 if tv.Tag == cmd.debugTag {
432 log.Printf("infile %d %s tag %d variant %d hash %x", infileIdx, infile, tv.Tag, tv.Variant, tv.Blake2b[:3])
434 variants := seq[tv.Tag]
435 if len(variants) == 0 {
436 variants = make([]TileVariant, 100)
438 for len(variants) <= int(tv.Variant) {
439 variants = append(variants, TileVariant{})
441 variants[int(tv.Variant)] = tv
442 seq[tv.Tag] = variants
444 for _, cg := range ent.CompactGenomes {
445 if cmd.filter.MaxTag >= 0 && cg.StartTag > tagID(cmd.filter.MaxTag) {
448 if !matchGenome.MatchString(cg.Name) {
451 // pad to full slice size
452 // to avoid out-of-bounds
454 if sliceSize := 2 * int(cg.EndTag-cg.StartTag); len(cg.Variants) < sliceSize {
455 cg.Variants = append(cg.Variants, make([]tileVariantID, sliceSize-len(cg.Variants))...)
463 } else if err != nil {
464 return fmt.Errorf("%04d: DecodeLibrary(%s): err", infileIdx, infile)
466 tagstart := cgs[cmd.cgnames[0]].StartTag
467 tagend := cgs[cmd.cgnames[0]].EndTag
468 chunkStartTag[infileIdx] = tagstart
472 log.Infof("%04d: renumber/dedup variants for tags %d-%d", infileIdx, tagstart, tagend)
473 variantRemap := make([][]tileVariantID, tagend-tagstart)
474 throttleCPU := throttle{Max: runtime.GOMAXPROCS(0)}
475 for tag, variants := range seq {
476 tag, variants := tag, variants
477 throttleCPU.Go(func() error {
479 count := make(map[[blake2b.Size256]byte]int, len(variants))
483 count[blake2b.Sum256(rt.tiledata)] = 0
486 for cgname, cg := range cgs {
487 idx := int(tag-tagstart) * 2
488 for allele := 0; allele < 2; allele++ {
489 v := cg.Variants[idx+allele]
490 if v > 0 && len(variants[v].Sequence) > 0 {
491 count[variants[v].Blake2b]++
494 if v > 0 && tag == cmd.debugTag {
495 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])
499 if alleleCoverage < cmd.minCoverage*2 {
500 idx := int(tag-tagstart) * 2
501 for _, cg := range cgs {
503 cg.Variants[idx+1] = 0
505 if tag == cmd.debugTag {
506 log.Printf("tag %d alleleCoverage %d < min %d, sample data wiped", tag, alleleCoverage, cmd.minCoverage*2)
511 // hash[i] will be the hash of
512 // the variant(s) that should
513 // be at rank i (0-based).
514 hash := make([][blake2b.Size256]byte, 0, len(count))
515 for b := range count {
516 hash = append(hash, b)
518 sort.Slice(hash, func(i, j int) bool {
519 bi, bj := &hash[i], &hash[j]
520 if ci, cj := count[*bi], count[*bj]; ci != cj {
523 return bytes.Compare((*bi)[:], (*bj)[:]) < 0
526 // rank[b] will be the 1-based
527 // new variant number for
528 // variants whose hash is b.
529 rank := make(map[[blake2b.Size256]byte]tileVariantID, len(hash))
530 for i, h := range hash {
531 rank[h] = tileVariantID(i + 1)
533 if tag == cmd.debugTag {
534 for h, r := range rank {
535 log.Printf("tag %d rank(%x) = %v", tag, h[:3], r)
538 // remap[v] will be the new
539 // variant number for original
541 remap := make([]tileVariantID, len(variants))
542 for i, tv := range variants {
543 remap[i] = rank[tv.Blake2b]
545 if tag == cmd.debugTag {
546 for in, out := range remap {
548 log.Printf("tag %d remap %d => %d", tag, in, out)
552 variantRemap[tag-tagstart] = remap
554 refrank := rank[blake2b.Sum256(rt.tiledata)]
555 if tag == cmd.debugTag {
556 log.Printf("tag %d reftile variant %d => %d", tag, rt.variant, refrank)
565 var onehotChunk [][]int8
566 var onehotXref []onehotXref
568 var annotationsFilename string
570 annotationsFilename = "/dev/null"
572 annotationsFilename = fmt.Sprintf("%s/matrix.%04d.annotations.csv", *outputDir, infileIdx)
573 log.Infof("%04d: writing %s", infileIdx, annotationsFilename)
575 annof, err := os.Create(annotationsFilename)
579 annow := bufio.NewWriterSize(annof, 1<<20)
581 for tag := tagstart; tag < tagend; tag++ {
583 if rt == nil && mask != nil {
584 // With no ref tile, we don't
585 // have coordinates to say
586 // this is in the desired
587 // regions -- so it's not.
588 // TODO: handle ref spanning
592 if rt != nil && rt.excluded {
593 // TODO: don't skip yet --
594 // first check for spanning
595 // tile variants that
596 // intersect non-excluded ref
600 if cmd.filter.MaxTag >= 0 && tag > tagID(cmd.filter.MaxTag) {
603 remap := variantRemap[tag-tagstart]
604 maxv := tileVariantID(0)
605 for _, v := range remap {
610 if *onehotChunked || *onehotSingle || *onlyPCA {
611 onehot, xrefs := cmd.tv2homhet(cgs, maxv, remap, tag, tagstart, seq)
612 if tag == cmd.debugTag {
613 log.WithFields(logrus.Fields{
616 }).Info("tv2homhet()")
618 onehotChunk = append(onehotChunk, onehot...)
619 onehotXref = append(onehotXref, xrefs...)
626 // Reference does not use any
627 // variant of this tile
629 // TODO: diff against the
630 // relevant portion of the
631 // ref's spanning tile
635 fmt.Fprintf(annow, "%d,%d,%d,=,%s,%d,,,\n", tag, outcol, rt.variant, rt.seqname, rt.pos)
637 reftilestr := strings.ToUpper(string(rt.tiledata))
639 done := make([]bool, maxv+1)
640 variantDiffs := make([][]hgvs.Variant, maxv+1)
641 for v, tv := range variants {
643 if v == 0 || v == rt.variant || done[v] {
648 if len(tv.Sequence) < taglen {
651 // if reftilestr doesn't end
652 // in the same tag as tv,
653 // extend reftilestr with
654 // following ref tiles until
655 // it does (up to an arbitrary
656 // sanity-check limit)
657 reftilestr := reftilestr
658 endtagstr := strings.ToUpper(string(tv.Sequence[len(tv.Sequence)-taglen:]))
659 for i, rt := 0, rt; i < annotationMaxTileSpan && !strings.HasSuffix(reftilestr, endtagstr) && rt.nexttag >= 0; i++ {
660 rt = reftile[rt.nexttag]
664 reftilestr += strings.ToUpper(string(rt.tiledata[taglen:]))
666 if mask != nil && !mask.Check(strings.TrimPrefix(rt.seqname, "chr"), rt.pos, rt.pos+len(reftilestr)) {
669 if !strings.HasSuffix(reftilestr, endtagstr) {
670 fmt.Fprintf(annow, "%d,%d,%d,,%s,%d,,,\n", tag, outcol, v, rt.seqname, rt.pos)
673 if lendiff := len(reftilestr) - len(tv.Sequence); lendiff < -1000 || lendiff > 1000 {
674 fmt.Fprintf(annow, "%d,%d,%d,,%s,%d,,,\n", tag, outcol, v, rt.seqname, rt.pos)
677 diffs, _ := hgvs.Diff(reftilestr, strings.ToUpper(string(tv.Sequence)), 0)
678 for i := range diffs {
679 diffs[i].Position += rt.pos
681 for _, diff := range diffs {
682 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)
685 variantDiffs[v] = diffs
689 // We can now determine, for each HGVS
690 // variant (diff) in this reftile
691 // region, whether a given genome
692 // phase/allele (1) has the variant, (0) has
693 // =ref or a different variant in that
694 // position, or (-1) is lacking
695 // coverage / couldn't be diffed.
696 hgvsCol := hgvsColSet{}
697 for _, diffs := range variantDiffs {
698 for _, diff := range diffs {
699 if _, ok := hgvsCol[diff]; ok {
702 hgvsCol[diff] = [2][]int8{
703 make([]int8, len(cmd.cgnames)),
704 make([]int8, len(cmd.cgnames)),
708 for row, name := range cmd.cgnames {
709 variants := cgs[name].Variants[(tag-tagstart)*2:]
710 for ph := 0; ph < 2; ph++ {
712 if int(v) >= len(remap) {
718 // hgvsCol[*][ph][row] is already 0
719 } else if len(variantDiffs[v]) == 0 {
720 // lacking coverage / couldn't be diffed
721 for _, col := range hgvsCol {
725 for _, diff := range variantDiffs[v] {
726 hgvsCol[diff][ph][row] = 1
731 for diff, colpair := range hgvsCol {
732 allele2homhet(colpair)
733 if !cmd.filterHGVScolpair(colpair) {
734 delete(hgvsCol, diff)
737 if len(hgvsCol) > 0 {
738 encodeHGVSTodo[rt.seqname] <- hgvsCol
753 // transpose onehotChunk[col][row] to numpy[row*ncols+col]
754 rows := len(cmd.cgnames)
755 cols := len(onehotChunk)
756 log.Infof("%04d: preparing onehot numpy (rows=%d, cols=%d, mem=%d)", infileIdx, rows, cols, rows*cols)
757 throttleNumpyMem.Acquire()
758 out := onehotcols2int8(onehotChunk)
759 fnm := fmt.Sprintf("%s/onehot.%04d.npy", *outputDir, infileIdx)
760 err = writeNumpyInt8(fnm, out, rows, cols)
764 fnm = fmt.Sprintf("%s/onehot-columns.%04d.npy", *outputDir, infileIdx)
765 err = writeNumpyInt32(fnm, onehotXref2int32(onehotXref), 4, len(onehotXref))
770 throttleNumpyMem.Release()
772 if *onehotSingle || *onlyPCA {
773 onehotIndirect[infileIdx] = onehotChunk2Indirect(onehotChunk)
774 onehotChunkSize[infileIdx] = uint32(len(onehotChunk))
775 onehotXrefs[infileIdx] = onehotXref
776 n := len(onehotIndirect[infileIdx][0])
777 log.Infof("%04d: keeping onehot coordinates in memory (n=%d, mem=%d)", infileIdx, n, n*8*2)
779 if !(*onehotSingle || *onehotChunked || *onlyPCA) || *mergeOutput || *hgvsSingle {
780 log.Infof("%04d: preparing numpy (rows=%d, cols=%d)", infileIdx, len(cmd.cgnames), 2*outcol)
781 throttleNumpyMem.Acquire()
782 rows := len(cmd.cgnames)
784 out := make([]int16, rows*cols)
785 for row, name := range cmd.cgnames {
787 for col, v := range cgs[name].Variants {
788 tag := tagstart + tagID(col/2)
789 if cmd.filter.MaxTag >= 0 && tag > tagID(cmd.filter.MaxTag) {
792 if rt := reftile[tag]; rt == nil || rt.excluded {
796 out[outidx] = 0 // tag not found / spanning tile
797 } else if variants, ok := seq[tag]; ok && int(v) < len(variants) && len(variants[v].Sequence) > 0 {
798 out[outidx] = int16(variantRemap[tag-tagstart][v])
800 out[outidx] = -1 // low quality tile variant
802 if tag == cmd.debugTag {
803 log.Printf("tag %d row %d col %d outidx %d v %d out %d", tag, row, col, outidx, v, out[outidx])
811 throttleNumpyMem.Release()
812 if *mergeOutput || *hgvsSingle {
813 log.Infof("%04d: matrix fragment %d rows x %d cols", infileIdx, rows, cols)
814 toMerge[infileIdx] = out
816 if !*mergeOutput && !*onehotChunked && !*onehotSingle {
817 fnm := fmt.Sprintf("%s/matrix.%04d.npy", *outputDir, infileIdx)
818 err = writeNumpyInt16(fnm, out, rows, cols)
825 log.Infof("%s: done (%d/%d)", infile, int(atomic.AddInt64(&done, 1)), len(infiles))
829 if err = throttleMem.Wait(); err != nil {
834 log.Info("flushing hgvsCols temp files")
835 for seqname := range refseq {
836 close(encodeHGVSTodo[seqname])
838 err = encodeHGVS.Wait()
842 for seqname := range refseq {
843 log.Infof("%s: reading hgvsCols from temp file", seqname)
844 f := tmpHGVSCols[seqname]
845 _, err = f.Seek(0, io.SeekStart)
849 var hgvsCols hgvsColSet
850 dec := gob.NewDecoder(bufio.NewReaderSize(f, 1<<24))
852 err = dec.Decode(&hgvsCols)
857 log.Infof("%s: sorting %d hgvs variants", seqname, len(hgvsCols))
858 variants := make([]hgvs.Variant, 0, len(hgvsCols))
859 for v := range hgvsCols {
860 variants = append(variants, v)
862 sort.Slice(variants, func(i, j int) bool {
863 vi, vj := &variants[i], &variants[j]
864 if vi.Position != vj.Position {
865 return vi.Position < vj.Position
866 } else if vi.Ref != vj.Ref {
867 return vi.Ref < vj.Ref
869 return vi.New < vj.New
872 rows := len(cmd.cgnames)
873 cols := len(variants) * 2
874 log.Infof("%s: building hgvs matrix (rows=%d, cols=%d, mem=%d)", seqname, rows, cols, rows*cols)
875 out := make([]int8, rows*cols)
876 for varIdx, variant := range variants {
877 hgvsCols := hgvsCols[variant]
878 for row := range cmd.cgnames {
879 for ph := 0; ph < 2; ph++ {
880 out[row*cols+varIdx+ph] = hgvsCols[ph][row]
884 err = writeNumpyInt8(fmt.Sprintf("%s/hgvs.%s.npy", *outputDir, seqname), out, rows, cols)
890 fnm := fmt.Sprintf("%s/hgvs.%s.annotations.csv", *outputDir, seqname)
891 log.Infof("%s: writing hgvs column labels to %s", seqname, fnm)
892 var hgvsLabels bytes.Buffer
893 for varIdx, variant := range variants {
894 fmt.Fprintf(&hgvsLabels, "%d,%s:g.%s\n", varIdx, seqname, variant.String())
896 err = ioutil.WriteFile(fnm, hgvsLabels.Bytes(), 0666)
903 if *mergeOutput || *hgvsSingle {
904 var annow *bufio.Writer
907 annoFilename := fmt.Sprintf("%s/matrix.annotations.csv", *outputDir)
908 annof, err = os.Create(annoFilename)
912 annow = bufio.NewWriterSize(annof, 1<<20)
915 rows := len(cmd.cgnames)
917 for _, chunk := range toMerge {
918 cols += len(chunk) / rows
920 log.Infof("merging output matrix (rows=%d, cols=%d, mem=%d) and annotations", rows, cols, rows*cols*2)
923 out = make([]int16, rows*cols)
925 hgvsCols := map[string][2][]int16{} // hgvs -> [[g0,g1,g2,...], [g0,g1,g2,...]] (slice of genomes for each phase)
927 for outIdx, chunk := range toMerge {
928 chunkcols := len(chunk) / rows
930 for row := 0; row < rows; row++ {
931 copy(out[row*cols+startcol:], chunk[row*chunkcols:(row+1)*chunkcols])
934 toMerge[outIdx] = nil
936 annotationsFilename := fmt.Sprintf("%s/matrix.%04d.annotations.csv", *outputDir, outIdx)
937 log.Infof("reading %s", annotationsFilename)
938 buf, err := os.ReadFile(annotationsFilename)
943 err = os.Remove(annotationsFilename)
948 for _, line := range bytes.Split(buf, []byte{'\n'}) {
952 fields := bytes.SplitN(line, []byte{','}, 9)
953 tag, _ := strconv.Atoi(string(fields[0]))
954 incol, _ := strconv.Atoi(string(fields[1]))
955 tileVariant, _ := strconv.Atoi(string(fields[2]))
956 hgvsID := string(fields[3])
957 seqname := string(fields[4])
958 pos, _ := strconv.Atoi(string(fields[5]))
961 // Null entry for un-diffable
966 // Null entry for ref tile
969 if mask != nil && !mask.Check(strings.TrimPrefix(seqname, "chr"), pos, pos+len(refseq)) {
970 // The tile intersects one of
971 // the selected regions, but
972 // this particular HGVS
976 hgvsColPair := hgvsCols[hgvsID]
977 if hgvsColPair[0] == nil {
978 // values in new columns start
979 // out as -1 ("no data yet")
980 // or 0 ("=ref") here, may
981 // change to 1 ("hgvs variant
982 // present") below, either on
983 // this line or a future line.
984 hgvsColPair = [2][]int16{make([]int16, len(cmd.cgnames)), make([]int16, len(cmd.cgnames))}
985 rt, ok := reftile[tagID(tag)]
987 err = fmt.Errorf("bug: seeing annotations for tag %d, but it has no reftile entry", tag)
990 for ph := 0; ph < 2; ph++ {
991 for row := 0; row < rows; row++ {
992 v := chunk[row*chunkcols+incol*2+ph]
993 if tileVariantID(v) == rt.variant {
994 hgvsColPair[ph][row] = 0
996 hgvsColPair[ph][row] = -1
1000 hgvsCols[hgvsID] = hgvsColPair
1002 hgvsref := hgvs.Variant{
1004 Ref: string(refseq),
1005 New: string(refseq),
1007 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])
1011 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])
1013 for ph := 0; ph < 2; ph++ {
1014 for row := 0; row < rows; row++ {
1015 v := chunk[row*chunkcols+incol*2+ph]
1016 if int(v) == tileVariant {
1017 hgvsColPair[ph][row] = 1
1023 startcol += chunkcols
1034 err = writeNumpyInt16(fmt.Sprintf("%s/matrix.npy", *outputDir), out, rows, cols)
1042 cols = len(hgvsCols) * 2
1043 log.Printf("building hgvs-based matrix: %d rows x %d cols", rows, cols)
1044 out = make([]int16, rows*cols)
1045 hgvsIDs := make([]string, 0, cols/2)
1046 for hgvsID := range hgvsCols {
1047 hgvsIDs = append(hgvsIDs, hgvsID)
1049 sort.Strings(hgvsIDs)
1050 var hgvsLabels bytes.Buffer
1051 for idx, hgvsID := range hgvsIDs {
1052 fmt.Fprintf(&hgvsLabels, "%d,%s\n", idx, hgvsID)
1053 for ph := 0; ph < 2; ph++ {
1054 hgvscol := hgvsCols[hgvsID][ph]
1055 for row, val := range hgvscol {
1056 out[row*cols+idx*2+ph] = val
1060 err = writeNumpyInt16(fmt.Sprintf("%s/hgvs.npy", *outputDir), out, rows, cols)
1065 fnm := fmt.Sprintf("%s/hgvs.annotations.csv", *outputDir)
1066 log.Printf("writing hgvs labels: %s", fnm)
1067 err = ioutil.WriteFile(fnm, hgvsLabels.Bytes(), 0777)
1073 if *onehotSingle || *onlyPCA {
1075 for _, part := range onehotIndirect {
1076 nzCount += len(part[0])
1078 onehot := make([]uint32, nzCount*2) // [r,r,r,...,c,c,c,...]
1079 var xrefs []onehotXref
1080 chunkOffset := uint32(0)
1082 for i, part := range onehotIndirect {
1083 for i := range part[1] {
1084 part[1][i] += chunkOffset
1086 copy(onehot[outcol:], part[0])
1087 copy(onehot[outcol+nzCount:], part[1])
1088 xrefs = append(xrefs, onehotXrefs[i]...)
1090 outcol += len(part[0])
1091 chunkOffset += onehotChunkSize[i]
1095 onehotXrefs[i] = nil
1096 debug.FreeOSMemory()
1099 fnm := fmt.Sprintf("%s/onehot.npy", *outputDir)
1100 err = writeNumpyUint32(fnm, onehot, 2, nzCount)
1104 fnm = fmt.Sprintf("%s/onehot-columns.npy", *outputDir)
1105 err = writeNumpyInt32(fnm, onehotXref2int32(xrefs), 5, len(xrefs))
1112 for _, c := range onehot[nzCount:] {
1118 return fmt.Errorf("cannot do PCA: one-hot matrix is empty")
1120 log.Printf("creating matrix: %d rows, %d cols", len(cmd.cgnames), cols)
1121 mtx := mat.NewDense(len(cmd.cgnames), cols, nil)
1122 for i, c := range onehot[nzCount:] {
1123 mtx.Set(int(onehot[i]), int(c), 1)
1125 log.Print("fitting")
1126 transformer := nlp.NewPCA(*pcaComponents)
1127 transformer.Fit(mtx.T())
1128 log.Printf("transforming")
1129 pca, err := transformer.Transform(mtx.T())
1134 outrows, outcols := pca.Dims()
1135 log.Printf("copying result to numpy output array: %d rows, %d cols", outrows, outcols)
1136 out := make([]float64, outrows*outcols)
1137 for i := 0; i < outrows; i++ {
1138 for j := 0; j < outcols; j++ {
1139 out[i*outcols+j] = pca.At(i, j)
1142 fnm := fmt.Sprintf("%s/pca.npy", *outputDir)
1143 log.Printf("writing numpy: %s", fnm)
1144 output, err := os.OpenFile(fnm, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0777)
1148 npw, err := gonpy.NewWriter(nopCloser{output})
1150 return fmt.Errorf("gonpy.NewWriter: %w", err)
1152 npw.Shape = []int{outrows, outcols}
1153 err = npw.WriteFloat64(out)
1155 return fmt.Errorf("WriteFloat64: %w", err)
1157 err = output.Close()
1164 if !*mergeOutput && !*onehotChunked && !*onehotSingle && !*onlyPCA {
1165 tagoffsetFilename := *outputDir + "/chunk-tag-offset.csv"
1166 log.Infof("writing tag offsets to %s", tagoffsetFilename)
1168 f, err = os.Create(tagoffsetFilename)
1173 for idx, offset := range chunkStartTag {
1174 _, err = fmt.Fprintf(f, "%q,%d\n", fmt.Sprintf("matrix.%04d.npy", idx), offset)
1176 err = fmt.Errorf("write %s: %w", tagoffsetFilename, err)
1182 err = fmt.Errorf("close %s: %w", tagoffsetFilename, err)
1189 // Read case/control files, remove non-case/control entries from
1190 // cmd.cgnames, and build cmd.chi2Cases.
1191 func (cmd *sliceNumpy) useCaseControlFiles() error {
1192 if cmd.chi2CaseControlFile == "" {
1195 infiles, err := allFiles(cmd.chi2CaseControlFile, nil)
1199 // index in cmd.cgnames => case(true) / control(false)
1200 cc := map[int]bool{}
1201 for _, infile := range infiles {
1202 f, err := open(infile)
1206 buf, err := io.ReadAll(f)
1212 for _, tsv := range bytes.Split(buf, []byte{'\n'}) {
1216 split := strings.Split(string(tsv), "\t")
1219 for col, name := range split {
1220 if name == cmd.chi2CaseControlColumn {
1226 return fmt.Errorf("%s: no column named %q in header row %q", infile, cmd.chi2CaseControlColumn, tsv)
1230 if len(split) <= ccCol {
1235 for i, name := range cmd.cgnames {
1236 if strings.Contains(name, pattern) {
1238 log.Warnf("pattern %q in %s matches multiple genome IDs (%qs, %q)", pattern, infile, cmd.cgnames[found], name)
1244 log.Warnf("pattern %q in %s does not match any genome IDs", pattern, infile)
1247 if split[ccCol] == "0" {
1250 if split[ccCol] == "1" {
1255 allnames := cmd.cgnames
1259 for i, name := range allnames {
1260 if cc, ok := cc[i]; ok {
1261 cmd.cgnames = append(cmd.cgnames, name)
1262 cmd.chi2Cases = append(cmd.chi2Cases, cc)
1268 log.Printf("%d cases, %d controls, %d neither (dropped)", ncases, len(cmd.cgnames)-ncases, len(allnames)-len(cmd.cgnames))
1272 func (cmd *sliceNumpy) filterHGVScolpair(colpair [2][]int8) bool {
1273 if cmd.chi2PValue >= 1 {
1276 col0 := make([]bool, 0, len(cmd.chi2Cases))
1277 col1 := make([]bool, 0, len(cmd.chi2Cases))
1278 cases := make([]bool, 0, len(cmd.chi2Cases))
1279 for i, c := range cmd.chi2Cases {
1280 if colpair[0][i] < 0 {
1283 col0 = append(col0, colpair[0][i] != 0)
1284 col1 = append(col1, colpair[1][i] != 0)
1285 cases = append(cases, c)
1287 return len(cases) >= cmd.minCoverage &&
1288 (pvalue(col0, cases) <= cmd.chi2PValue || pvalue(col1, cases) <= cmd.chi2PValue)
1291 func writeNumpyUint32(fnm string, out []uint32, rows, cols int) error {
1292 output, err := os.Create(fnm)
1296 defer output.Close()
1297 bufw := bufio.NewWriterSize(output, 1<<26)
1298 npw, err := gonpy.NewWriter(nopCloser{bufw})
1302 log.WithFields(log.Fields{
1306 "bytes": rows * cols * 4,
1307 }).Infof("writing numpy: %s", fnm)
1308 npw.Shape = []int{rows, cols}
1309 npw.WriteUint32(out)
1314 return output.Close()
1317 func writeNumpyInt32(fnm string, out []int32, rows, cols int) error {
1318 output, err := os.Create(fnm)
1322 defer output.Close()
1323 bufw := bufio.NewWriterSize(output, 1<<26)
1324 npw, err := gonpy.NewWriter(nopCloser{bufw})
1328 log.WithFields(log.Fields{
1332 "bytes": rows * cols * 4,
1333 }).Infof("writing numpy: %s", fnm)
1334 npw.Shape = []int{rows, cols}
1340 return output.Close()
1343 func writeNumpyInt16(fnm string, out []int16, rows, cols int) error {
1344 output, err := os.Create(fnm)
1348 defer output.Close()
1349 bufw := bufio.NewWriterSize(output, 1<<26)
1350 npw, err := gonpy.NewWriter(nopCloser{bufw})
1354 log.WithFields(log.Fields{
1358 "bytes": rows * cols * 2,
1359 }).Infof("writing numpy: %s", fnm)
1360 npw.Shape = []int{rows, cols}
1366 return output.Close()
1369 func writeNumpyInt8(fnm string, out []int8, rows, cols int) error {
1370 output, err := os.Create(fnm)
1374 defer output.Close()
1375 bufw := bufio.NewWriterSize(output, 1<<26)
1376 npw, err := gonpy.NewWriter(nopCloser{bufw})
1380 log.WithFields(log.Fields{
1384 "bytes": rows * cols,
1385 }).Infof("writing numpy: %s", fnm)
1386 npw.Shape = []int{rows, cols}
1392 return output.Close()
1395 func allele2homhet(colpair [2][]int8) {
1396 a, b := colpair[0], colpair[1]
1397 for i, av := range a {
1399 if av < 0 || bv < 0 {
1402 } else if av > 0 && bv > 0 {
1405 } else if av > 0 || bv > 0 {
1409 // ref (or a different variant in same position)
1410 // (this is a no-op) a[i], b[i] = 0, 0
1415 type onehotXref struct {
1417 variant tileVariantID
1422 const onehotXrefSize = unsafe.Sizeof(onehotXref{})
1424 // Build onehot matrix (m[tileVariantIndex][genome] == 0 or 1) for all
1425 // variants of a single tile/tag#.
1427 // Return nil if no tile variant passes Χ² filter.
1428 func (cmd *sliceNumpy) tv2homhet(cgs map[string]CompactGenome, maxv tileVariantID, remap []tileVariantID, tag, chunkstarttag tagID, seq map[tagID][]TileVariant) ([][]int8, []onehotXref) {
1429 if tag == cmd.debugTag {
1430 tv := make([]tileVariantID, len(cmd.cgnames)*2)
1431 for i, name := range cmd.cgnames {
1432 copy(tv[i*2:(i+1)*2], cgs[name].Variants[(tag-chunkstarttag)*2:])
1434 log.WithFields(logrus.Fields{
1435 "cgs[i].Variants[tag*2+j]": tv,
1439 "chunkstarttag": chunkstarttag,
1440 }).Info("tv2homhet()")
1442 if maxv < 1 || (maxv < 2 && !cmd.includeVariant1) {
1443 // everyone has the most common variant (of the variants we don't drop)
1446 tagoffset := tag - chunkstarttag
1448 for _, cg := range cgs {
1450 for _, v := range cg.Variants[tagoffset*2 : tagoffset*2+2] {
1451 if v > 0 && int(v) < len(seq[tag]) && len(seq[tag][v].Sequence) > 0 {
1459 if coverage < cmd.minCoverage {
1462 obs := make([][]bool, (maxv+1)*2) // 2 slices (hom + het) for each variant#
1463 for i := range obs {
1464 obs[i] = make([]bool, len(cmd.cgnames))
1466 for cgid, name := range cmd.cgnames {
1467 cgvars := cgs[name].Variants[tagoffset*2:]
1468 tv0, tv1 := remap[cgvars[0]], remap[cgvars[1]]
1469 for v := tileVariantID(1); v <= maxv; v++ {
1470 if tv0 == v && tv1 == v {
1471 obs[v*2][cgid] = true
1472 } else if tv0 == v || tv1 == v {
1473 obs[v*2+1][cgid] = true
1478 var xref []onehotXref
1479 for col := 2; col < len(obs); col++ {
1480 // col 0,1 correspond to tile variant 0, i.e.,
1481 // no-call; col 2,3 correspond to the most common
1482 // variant; so we (normally) start at col 4.
1483 if col < 4 && !cmd.includeVariant1 {
1486 p := pvalue(obs[col], cmd.chi2Cases)
1487 if cmd.chi2PValue < 1 && !(p < cmd.chi2PValue) {
1490 onehot = append(onehot, bool2int8(obs[col]))
1491 xref = append(xref, onehotXref{
1493 variant: tileVariantID(col >> 1),
1501 func bool2int8(in []bool) []int8 {
1502 out := make([]int8, len(in))
1503 for i, v := range in {
1511 // convert a []onehotXref with length N to a numpy-style []int32
1512 // matrix with N columns, one row per field of onehotXref struct.
1514 // Hom/het row contains hom=0, het=1.
1516 // P-value row contains 1000000x actual p-value.
1517 func onehotXref2int32(xrefs []onehotXref) []int32 {
1519 xdata := make([]int32, 5*xcols)
1520 for i, xref := range xrefs {
1521 xdata[i] = int32(xref.tag)
1522 xdata[xcols+i] = int32(xref.variant)
1524 xdata[xcols*2+i] = 1
1526 xdata[xcols*3+i] = int32(xref.pvalue * 1000000)
1527 xdata[xcols*4+i] = int32(-math.Log10(xref.pvalue) * 1000000)
1532 // transpose onehot data from in[col][row] to numpy-style
1533 // out[row*cols+col].
1534 func onehotcols2int8(in [][]int8) []int8 {
1540 out := make([]int8, rows*cols)
1541 for row := 0; row < rows; row++ {
1542 outrow := out[row*cols:]
1543 for col, incol := range in {
1544 outrow[col] = incol[row]
1550 // Return [2][]uint32{rowIndices, colIndices} indicating which
1551 // elements of matrixT[c][r] have non-zero values.
1552 func onehotChunk2Indirect(matrixT [][]int8) [2][]uint32 {
1554 for c, col := range matrixT {
1555 for r, val := range col {
1557 nz[0] = append(nz[0], uint32(r))
1558 nz[1] = append(nz[1], uint32(c))