@jbrowse/img 2.2.0 → 2.2.2

package/src/renderRegion.tsx

@@ -0,0 +1,456 @@
+import React from 'react'
+import { createViewState } from '@jbrowse/react-linear-genome-view'
+import {
+  LinearGenomeViewModel,
+  renderToSvg,
+} from '@jbrowse/plugin-linear-genome-view'
+import createCache from '@emotion/cache'
+import { CacheProvider } from '@emotion/react'
+import path from 'path'
+import fs from 'fs'
+
+// local
+import { Entry } from './parseArgv'
+import { booleanize } from './util'
+
+export interface Opts {
+  noRasterize?: boolean
+  loc?: string
+  width?: number
+  session?: string
+  assembly?: string
+  config?: string
+  fasta?: string
+  aliases?: string
+  cytobands?: string
+  defaultSession?: string
+  trackList: Entry[]
+  tracks?: string
+}
+
+function read(file: string) {
+  let res
+  try {
+    res = JSON.parse(fs.readFileSync(file, 'utf8'))
+  } catch (e) {
+    throw new Error(
+      `Failed to parse ${file} as JSON, use --fasta if you mean to pass a FASTA file`,
+    )
+  }
+  return res
+}
+function makeLocation(file: string) {
+  return file.startsWith('http') ? { uri: file } : { localPath: file }
+}
+
+function addRelativePaths(config: Record<string, unknown>, configPath: string) {
+  if (typeof config === 'object') {
+    for (const key of Object.keys(config)) {
+      if (typeof config[key] === 'object') {
+        addRelativePaths(config[key] as Record<string, unknown>, configPath)
+      } else if (key === 'localPath') {
+        config.localPath = path.resolve(configPath, config.localPath as string)
+      }
+    }
+  }
+}
+
+interface Assembly {
+  name: string
+  sequence: Record<string, unknown>
+  refNameAliases?: Record<string, unknown>
+  cytobands?: Record<string, unknown>
+}
+
+interface Track {
+  trackId: string
+  [key: string]: unknown
+}
+interface Config {
+  assemblies: Assembly[]
+  assembly: Assembly
+  tracks: Track[]
+  [key: string]: unknown
+}
+
+export function readData({
+  assembly: asm,
+  config,
+  session,
+  fasta,
+  aliases,
+  cytobands,
+  defaultSession,
+  tracks,
+  trackList = [],
+}: Opts) {
+  const assemblyData = asm && fs.existsSync(asm) ? read(asm) : undefined
+  const tracksData = tracks ? read(tracks) : undefined
+  const configData = (config ? read(config) : {}) as Config
+  let sessionData = session ? read(session) : undefined
+
+  if (config) {
+    addRelativePaths(configData, path.dirname(path.resolve(config)))
+  }
+
+  // the session.json can be a raw session or a json file with a "session"
+  // attribute, which is what is exported via the "File->Export session" in
+  // jbrowse-web
+  if (sessionData?.session) {
+    sessionData = sessionData.session
+  }
+
+  // only export first view
+  if (sessionData?.views) {
+    sessionData.view = sessionData.views[0]
+  }
+
+  // use assembly from file if a file existed
+  if (assemblyData) {
+    configData.assembly = assemblyData
+  }
+  // else check if it was an assembly name in a config file
+  else if (configData.assemblies?.length) {
+    configData.assemblies.find(entry => entry.name === asm)
+    if (asm) {
+      const assembly = configData.assemblies.find(entry => entry.name === asm)
+      if (!assembly) {
+        throw new Error(`assembly ${asm} not found in config`)
+      }
+      configData.assembly = assembly
+    } else {
+      configData.assembly = configData.assemblies[0]
+    }
+  }
+  // else load fasta from command line
+  else if (fasta) {
+    const bgzip = fasta.endsWith('gz')
+
+    configData.assembly = {
+      name: path.basename(fasta),
+      sequence: {
+        type: 'ReferenceSequenceTrack',
+        trackId: 'refseq',
+        adapter: {
+          type: bgzip ? 'BgzipFastaAdapter' : 'IndexedFastaAdapter',
+          fastaLocation: makeLocation(fasta),
+          faiLocation: makeLocation(fasta + '.fai'),
+          gziLocation: bgzip ? makeLocation(fasta + '.gzi') : undefined,
+        },
+      },
+    }
+    if (aliases) {
+      configData.assembly.refNameAliases = {
+        adapter: {
+          type: 'RefNameAliasAdapter',
+          location: makeLocation(aliases),
+        },
+      }
+    }
+    if (cytobands) {
+      configData.assembly.cytobands = {
+        adapter: {
+          type: 'CytobandAdapter',
+          location: makeLocation(cytobands),
+        },
+      }
+    }
+  }
+
+  // throw if still no assembly
+  if (!configData.assembly) {
+    throw new Error(
+      'no assembly specified, use --fasta to supply an indexed FASTA file (generated with samtools faidx yourfile.fa). see README for alternatives with --assembly and --config',
+    )
+  }
+
+  if (tracksData) {
+    configData.tracks = tracksData
+  } else if (!configData.tracks) {
+    configData.tracks = []
+  }
+
+  trackList.forEach(track => {
+    const [type, [file]] = track
+
+    if (type === 'bam') {
+      configData.tracks = [
+        ...configData.tracks,
+        {
+          type: 'AlignmentsTrack',
+          trackId: path.basename(file),
+          name: path.basename(file),
+          assemblyNames: [configData.assembly.name],
+          adapter: {
+            type: 'BamAdapter',
+            bamLocation: makeLocation(file),
+            index: { location: makeLocation(file + '.bai') },
+            sequenceAdapter: configData.assembly.sequence.adapter,
+          },
+        },
+      ]
+    }
+    if (type === 'cram') {
+      configData.tracks = [
+        ...configData.tracks,
+        {
+          type: 'AlignmentsTrack',
+          trackId: path.basename(file),
+          name: path.basename(file),
+          assemblyNames: [configData.assembly.name],
+          adapter: {
+            type: 'CramAdapter',
+            cramLocation: makeLocation(file),
+            craiLocation: makeLocation(file + '.crai'),
+            sequenceAdapter: configData.assembly.sequence.adapter,
+          },
+        },
+      ]
+    }
+    if (type === 'bigwig') {
+      configData.tracks = [
+        ...configData.tracks,
+        {
+          type: 'QuantitativeTrack',
+          trackId: path.basename(file),
+          name: path.basename(file),
+          assemblyNames: [configData.assembly.name],
+          adapter: {
+            type: 'BigWigAdapter',
+            bigWigLocation: makeLocation(file),
+          },
+        },
+      ]
+    }
+
+    if (type === 'vcfgz') {
+      configData.tracks = [
+        ...configData.tracks,
+        {
+          type: 'VariantTrack',
+          trackId: path.basename(file),
+          name: path.basename(file),
+          assemblyNames: [configData.assembly.name],
+          adapter: {
+            type: 'VcfTabixAdapter',
+            vcfGzLocation: makeLocation(file),
+            index: {
+              location: makeLocation(file + '.tbi'),
+            },
+          },
+        },
+      ]
+    }
+
+    if (type === 'gffgz') {
+      configData.tracks = [
+        ...configData.tracks,
+        {
+          type: 'FeatureTrack',
+          trackId: path.basename(file),
+          name: path.basename(file),
+          assemblyNames: [configData.assembly.name],
+          adapter: {
+            type: 'Gff3TabixAdapter',
+            gffGzLocation: makeLocation(file),
+            index: {
+              location: makeLocation(file + '.tbi'),
+            },
+          },
+        },
+      ]
+    }
+
+    if (type === 'hic') {
+      configData.tracks = [
+        ...configData.tracks,
+        {
+          type: 'HicTrack',
+          trackId: path.basename(file),
+          name: path.basename(file),
+          assemblyNames: [configData.assembly.name],
+          adapter: {
+            type: 'HicAdapter',
+            hicLocation: makeLocation(file),
+          },
+        },
+      ]
+    }
+    if (type === 'bigbed') {
+      configData.tracks = [
+        ...configData.tracks,
+        {
+          type: 'FeatureTrack',
+          trackId: path.basename(file),
+          name: path.basename(file),
+          assemblyNames: [configData.assembly.name],
+          adapter: {
+            type: 'BigBedAdapter',
+            bigBedLocation: makeLocation(file),
+          },
+        },
+      ]
+    }
+    if (type === 'bedgz') {
+      configData.tracks = [
+        ...configData.tracks,
+        {
+          type: 'FeatureTrack',
+          trackId: path.basename(file),
+          name: path.basename(file),
+          assemblyNames: [configData.assembly.name],
+          adapter: {
+            type: 'BedTabixAdapter',
+            bedGzLocation: makeLocation(file),
+            index: {
+              location: makeLocation(file + '.tbi'),
+            },
+          },
+        },
+      ]
+    }
+  })
+
+  if (!defaultSession) {
+    // don't use defaultSession from config.json file, can result in assembly
+    // name confusion
+    delete configData.defaultSession
+  }
+
+  // only allow an external manually specified session
+  if (sessionData) {
+    configData.defaultSession = sessionData
+  }
+
+  return configData
+}
+
+// without this, the styles can become messed up especially in lgv header
+// xref https://github.com/garronej/tss-react/issues/25
+export const muiCache = createCache({
+  key: 'mui',
+  prepend: true,
+})
+
+function process(
+  trackEntry: Entry,
+  view: LinearGenomeViewModel,
+  extra: (arg: string) => string = c => c,
+) {
+  const [, [track, ...opts]] = trackEntry
+  const currentTrack = view.showTrack(extra(track))
+  const display = currentTrack.displays[0]
+  opts.forEach(opt => {
+    // apply height to any track
+    if (opt.startsWith('height:')) {
+      const [, height] = opt.split(':')
+      display.setHeight(+height)
+    }
+
+    // apply sort to pileup
+    else if (opt.startsWith('sort:')) {
+      const [, type, tag] = opt.split(':')
+      display.PileupDisplay.setSortedBy(type, tag)
+    }
+
+    // apply color scheme to pileup
+    else if (opt.startsWith('color:')) {
+      const [, type, tag] = opt.split(':')
+      if (display.PileupDisplay) {
+        display.PileupDisplay.setColorScheme({ type, tag })
+      } else {
+        display.setColor(type)
+      }
+    }
+
+    // force track to render even if maxbpperpx limit hit...
+    else if (opt.startsWith('force:')) {
+      const [, force] = opt.split(':')
+      if (force) {
+        display.updateStatsLimit({ bytes: Number.MAX_VALUE })
+      }
+    }
+
+    // apply wiggle autoscale
+    else if (opt.startsWith('autoscale:')) {
+      const [, autoscale] = opt.split(':')
+      display.setAutoscale(autoscale)
+    }
+
+    // apply min and max score to wiggle
+    else if (opt.startsWith('minmax:')) {
+      const [, min, max] = opt.split(':')
+      display.setMinScore(+min)
+      display.setMaxScore(+max)
+    }
+
+    // apply linear or log scale to wiggle
+    else if (opt.startsWith('scaletype:')) {
+      const [, scaletype] = opt.split(':')
+      display.setScaleType(scaletype)
+    }
+
+    // draw crosshatches on wiggle
+    else if (opt.startsWith('crosshatch:')) {
+      const [, val] = opt.split(':')
+      display.setCrossHatches(booleanize(val))
+    }
+
+    // turn off fill on bigwig with fill:false
+    else if (opt.startsWith('fill:')) {
+      const [, val] = opt.split(':')
+      display.setFill(booleanize(val))
+    }
+
+    // set resolution:superfine to use finer bigwig bin size
+    else if (opt.startsWith('resolution:')) {
+      let [, val] = opt.split(':')
+      if (val === 'fine') {
+        val = '10'
+      } else if (val === 'superfine') {
+        val = '100'
+      }
+      display.setResolution(+val)
+    }
+  })
+}
+
+export async function renderRegion(opts: Opts) {
+  const model = createViewState(readData(opts))
+  const {
+    loc,
+    width = 1500,
+    trackList = [],
+    session: sessionParam,
+    defaultSession,
+  } = opts
+
+  const { session } = model
+  const { view } = session
+  const { assemblyManager } = model
+
+  view.setWidth(width)
+
+  if (loc) {
+    const [assembly] = assemblyManager.assemblies
+    if (loc === 'all') {
+      view.showAllRegionsInAssembly(assembly.name)
+    } else {
+      await view.navToLocString(loc, assembly.name)
+    }
+  } else if (!sessionParam && !defaultSession) {
+    console.warn('No loc specified')
+  }
+
+  trackList.forEach(track => {
+    process(track, view, extra => path.basename(extra))
+  })
+
+  return renderToSvg(view, {
+    rasterizeLayers: !opts.noRasterize,
+    ...opts,
+    Wrapper: ({ children }) => (
+      <CacheProvider value={muiCache}>{children}</CacheProvider>
+    ),
+  })
+}

package/src/util.ts

@@ -0,0 +1,32 @@
+import fs from 'fs'
+import tmp from 'tmp'
+import { spawnSync } from 'child_process'
+
+// nice helper function from https://stackoverflow.com/questions/263965/
+export function booleanize(str: string) {
+  return str === 'false' ? false : !!str
+}
+
+function createTmp() {
+  return tmp.fileSync({
+    mode: 0o644,
+    prefix: 'prefix-',
+    postfix: '.svg',
+  })
+}
+
+export function convert(
+  result: string,
+  args: { out: string; pngwidth?: string },
+  spawnArgs: string[] = [],
+) {
+  const { name } = createTmp()
+  const { pngwidth = '2048', out } = args
+  fs.writeFileSync(name, result)
+  const a = ['-w', pngwidth, name, '-o', out, ...spawnArgs] as string[]
+  const ls = spawnSync('rsvg-convert', a)
+
+  console.error(`rsvg-convert stderr: ${ls.stderr.toString()}`)
+  console.log(`rsvg-convert stdout: ${ls.stdout.toString()}`) // eslint-disable-line no-console
+  fs.unlinkSync(name)
+}

package/dist/index.testmod.js

@@ -1,210 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-var _renderRegion = require("./renderRegion");
-var _fs = _interopRequireDefault(require("fs"));
-var _jsdom = require("jsdom");
-require("abortcontroller-polyfill/dist/abortcontroller-polyfill-only");
-var _canvas = require("canvas");
-var document = new _jsdom.JSDOM("...").window.document;
-global.document = document;
-global.nodeImage = _canvas.Image;
-global.nodeCreateCanvas = _canvas.createCanvas;
-function hashCode(str) {
-  var hash = 0;
-  var chr;
-  if (str.length === 0) {
-    return hash;
-  }
-  for (var i = 0; i < str.length; i++) {
-    chr = str.charCodeAt(i);
-    hash = (hash << 5) - hash + chr;
-    hash |= 0; // Convert to 32bit integer
-  }
-
-  return hash;
-}
-var timeout = 20000;
-
-// commented out for using remote files currently
-xtest('renders a region with --session and --config args', /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-  var result;
-  return _regenerator.default.wrap(function _callee$(_context) {
-    while (1) {
-      switch (_context.prev = _context.next) {
-        case 0:
-          _context.next = 2;
-          return (0, _renderRegion.renderRegion)({
-            session: require.resolve('../test/clingen_session.json'),
-            config: require.resolve('../data/config.json')
-          });
-        case 2:
-          result = _context.sent;
-          _fs.default.writeFileSync('svg_from_config_and_session_param.svg', result);
-          expect(hashCode(result)).toMatchSnapshot();
-        case 5:
-        case "end":
-          return _context.stop();
-      }
-    }
-  }, _callee);
-})), timeout);
-
-// commented out for using remote files currently
-xtest('renders a region with --session, --tracks, and --assembly args', /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-  var result;
-  return _regenerator.default.wrap(function _callee2$(_context2) {
-    while (1) {
-      switch (_context2.prev = _context2.next) {
-        case 0:
-          _context2.next = 2;
-          return (0, _renderRegion.renderRegion)({
-            session: require.resolve('../test/clingen_session.json'),
-            tracks: require.resolve('../data/tracks.json'),
-            assembly: require.resolve('../data/assembly.json')
-          });
-        case 2:
-          result = _context2.sent;
-          _fs.default.writeFileSync('svg_from_separate_session_and_tracks.svg', result);
-          expect(hashCode(result)).toMatchSnapshot();
-        case 5:
-        case "end":
-          return _context2.stop();
-      }
-    }
-  }, _callee2);
-})), timeout);
-test('renders volvox with variety of args', /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
-  var fp, result;
-  return _regenerator.default.wrap(function _callee3$(_context3) {
-    while (1) {
-      switch (_context3.prev = _context3.next) {
-        case 0:
-          fp = function fp(f) {
-            return require.resolve('../data/volvox/' + f);
-          };
-          console.error = jest.fn();
-          _context3.next = 4;
-          return (0, _renderRegion.renderRegion)({
-            fasta: fp('volvox.fa'),
-            trackList: [['bam', [fp('volvox-sorted.bam')]], ['cram', [fp('volvox-sorted.cram')]], ['bigwig', [fp('volvox-sorted.bam.coverage.bw')]], ['vcfgz', [fp('volvox.filtered.vcf.gz')]], ['gffgz', [fp('volvox.sort.gff3.gz')]], ['bigbed', [fp('volvox.bb')]], ['bedgz', [fp('volvox-bed12.bed.gz')]]],
-            loc: 'ctgA:1000-2000'
-          });
-        case 4:
-          result = _context3.sent;
-          // can't do a snapshot test here, slightly inconsistent results(?)
-          _fs.default.writeFileSync(require.resolve('../test/svg_from_volvox_fasta_and_bam.svg'), result);
-          expect(result).toBeTruthy();
-        case 7:
-        case "end":
-          return _context3.stop();
-      }
-    }
-  }, _callee3);
-})), timeout);
-test('renders volvox with variety of args (noRasterize)', /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
-  var fp, result;
-  return _regenerator.default.wrap(function _callee4$(_context4) {
-    while (1) {
-      switch (_context4.prev = _context4.next) {
-        case 0:
-          fp = function fp(f) {
-            return require.resolve('../data/volvox/' + f);
-          };
-          console.error = jest.fn();
-          _context4.next = 4;
-          return (0, _renderRegion.renderRegion)({
-            fasta: fp('volvox.fa'),
-            trackList: [['bam', [fp('volvox-sorted.bam')]], ['cram', [fp('volvox-sorted.cram')]], ['bigwig', [fp('volvox-sorted.bam.coverage.bw')]], ['vcfgz', [fp('volvox.filtered.vcf.gz')]], ['gffgz', [fp('volvox.sort.gff3.gz')]], ['bigbed', [fp('volvox.bb')]], ['bedgz', [fp('volvox-bed12.bed.gz')]]],
-            loc: 'ctgA:1000-2000',
-            noRasterize: true
-          });
-        case 4:
-          result = _context4.sent;
-          // can't do a snapshot test here, slightly inconsistent results(?)
-          _fs.default.writeFileSync(require.resolve('../test/svg_from_volvox_fasta_and_bam_norasterize.svg'), result);
-          expect(result).toBeTruthy();
-        case 7:
-        case "end":
-          return _context4.stop();
-      }
-    }
-  }, _callee4);
-})), timeout);
-
-// commented out for using remote files currently
-xtest('configtracks arg with urls', /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
-  var result;
-  return _regenerator.default.wrap(function _callee5$(_context5) {
-    while (1) {
-      switch (_context5.prev = _context5.next) {
-        case 0:
-          _context5.next = 2;
-          return (0, _renderRegion.renderRegion)({
-            config: 'data/config.json',
-            trackList: [['configtracks', ['ncbi_refseq_109_hg38']]],
-            assembly: 'GRCh38',
-            loc: 'chr1:50,000-60,000'
-          });
-        case 2:
-          result = _context5.sent;
-          // can't do a snapshot test here, slightly inconsistent results(?)
-          _fs.default.writeFileSync('svg_configtracks_simple.svg', result);
-          expect(result).toBeTruthy();
-        case 5:
-        case "end":
-          return _context5.stop();
-      }
-    }
-  }, _callee5);
-})), timeout * 3);
-test('configtracks arg with local files', /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
-  var result;
-  return _regenerator.default.wrap(function _callee6$(_context6) {
-    while (1) {
-      switch (_context6.prev = _context6.next) {
-        case 0:
-          _context6.next = 2;
-          return (0, _renderRegion.renderRegion)({
-            config: require.resolve('../data/volvox/config.json'),
-            trackList: [['configtracks', ['volvox_sv']]],
-            assembly: 'volvox',
-            loc: 'ctgA:1-50,000'
-          });
-        case 2:
-          result = _context6.sent;
-          // can't do a snapshot test here, slightly inconsistent results(?)
-          _fs.default.writeFileSync(require.resolve('../test/svg_configtracks_local.svg'), result);
-          expect(result).toBeTruthy();
-        case 5:
-        case "end":
-          return _context6.stop();
-      }
-    }
-  }, _callee6);
-})), timeout * 3);
-xtest('renders --hic', /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
-  var result;
-  return _regenerator.default.wrap(function _callee7$(_context7) {
-    while (1) {
-      switch (_context7.prev = _context7.next) {
-        case 0:
-          _context7.next = 2;
-          return (0, _renderRegion.renderRegion)({
-            fasta: 'https://jbrowse.org/genomes/hg19/fasta/hg19.fa.gz',
-            trackList: [['hic', ['https://s3.amazonaws.com/igv.broadinstitute.org/data/hic/intra_nofrag_30.hic']]],
-            loc: '1:2,000,000-10,000,000'
-          });
-        case 2:
-          result = _context7.sent;
-          _fs.default.writeFileSync(require.resolve('../test/svg_from_human_hic.svg'), result);
-          expect(result).toBeTruthy();
-        case 5:
-        case "end":
-          return _context7.stop();
-      }
-    }
-  }, _callee7);
-})), 20000);

package/dist/parseArgv.testmod.js

@@ -1,7 +0,0 @@
-"use strict";
-
-var _parseArgv = require("./parseArgv");
-test('parse', function () {
-  var args = '--bam dad.bam color:red --vcf variants.vcf --bam mom.bam --defaultSession --out out.svg --noRasterize';
-  expect((0, _parseArgv.parseArgv)(args.split(' '))).toEqual([['bam', ['dad.bam', 'color:red']], ['vcf', ['variants.vcf']], ['bam', ['mom.bam']], ['defaultSession', []], ['out', ['out.svg']], ['noRasterize', []]]);
-});