@jbrowse/plugin-bed 2.17.0 → 3.0.0

package/dist/util.js

@@ -5,61 +5,60 @@ exports.featureData = featureData;
 exports.featureData2 = featureData2;
 exports.arrayify = arrayify;
 const generateBedMethylFeature_1 = require("./generateBedMethylFeature");
-const generateUcscTranscript_1 = require("./generateUcscTranscript");
 const generateRepeatMaskerFeature_1 = require("./generateRepeatMaskerFeature");
-function stringToStrand(f) {
-    if (f === '-1') {
-        return -1;
+const generateUcscTranscript_1 = require("./generateUcscTranscript");
+function defaultParser(fields, splitLine) {
+    let hasBlockCount = false;
+    const r = [];
+    for (let i = 0; i < splitLine.length; i++) {
+        if (fields[i] === 'blockCount') {
+            hasBlockCount = true;
+        }
+        r.push([fields[i], splitLine[i]]);
     }
-    else if (f === '+') {
-        return 1;
+    const obj = Object.fromEntries(r);
+    if (hasBlockCount) {
+        const { blockStarts, blockCount, chromStarts, thickEnd, thickStart, blockSizes, ...rest } = obj;
+        return {
+            ...rest,
+            blockStarts: arrayify(blockStarts),
+            chromStarts: arrayify(chromStarts),
+            blockSizes: arrayify(blockSizes),
+            thickStart: thickStart ? +thickStart : undefined,
+            thickEnd: thickEnd ? +thickEnd : undefined,
+            blockCount: blockCount ? +blockCount : undefined,
+        };
     }
     else {
-        return 0;
+        return obj;
     }
 }
-function defaultParser(fields, line) {
-    const obj = Object.fromEntries(line.split('\t').map((f, i) => [fields[i], f]));
-    const { blockStarts, blockCount, chromStarts, thickEnd, thickStart, blockSizes, ...rest } = obj;
-    return {
-        ...rest,
-        blockStarts: arrayify(blockStarts),
-        chromStarts: arrayify(chromStarts),
-        blockSizes: arrayify(blockSizes),
-        thickStart: thickStart ? +thickStart : undefined,
-        thickEnd: thickEnd ? +thickEnd : undefined,
-        blockCount: blockCount ? +blockCount : undefined,
-    };
-}
 function makeBlocks({ start, uniqueId, refName, chromStarts, blockCount, blockSizes, blockStarts, }) {
-    if (blockCount) {
-        const subfeatures = [];
-        const starts = chromStarts || blockStarts || [];
-        for (let b = 0; b < blockCount; b++) {
-            const bmin = (starts[b] || 0) + start;
-            const bsize = blockSizes === null || blockSizes === void 0 ? void 0 : blockSizes[b];
-            if (bsize && bsize > 0) {
-                const bmax = bmin + bsize;
-                subfeatures.push({
-                    uniqueId: `${uniqueId}-${b}`,
-                    start: bmin,
-                    end: bmax,
-                    refName,
-                    type: 'block',
-                });
-            }
+    const subfeatures = [];
+    const starts = chromStarts || blockStarts || [];
+    for (let b = 0; b < blockCount; b++) {
+        const bmin = (starts[b] || 0) + start;
+        const bsize = blockSizes === null || blockSizes === void 0 ? void 0 : blockSizes[b];
+        if (bsize && bsize > 0) {
+            const bmax = bmin + bsize;
+            subfeatures.push({
+                uniqueId: `${uniqueId}-${b}`,
+                start: bmin,
+                end: bmax,
+                refName,
+                type: 'block',
+            });
         }
-        return subfeatures;
     }
-    return [];
+    return subfeatures;
 }
 function featureData({ line, colRef, colStart, colEnd, scoreColumn, parser, uniqueId, names, }) {
     const splitLine = line.split('\t');
     const refName = splitLine[colRef];
-    const start = +splitLine[colStart];
-    const end = +splitLine[colEnd] + (colStart === colEnd ? 1 : 0);
+    const start = Number.parseInt(splitLine[colStart], 10);
+    const end = Number.parseInt(splitLine[colEnd], 10) + (colStart === colEnd ? 1 : 0);
     return featureData2({
-        line,
+        splitLine,
         refName,
         start,
         end,
@@ -69,34 +68,35 @@ function featureData({ line, colRef, colStart, colEnd, scoreColumn, parser, uniq
         names,
     });
 }
-function featureData2({ line, refName, start, end, parser, uniqueId, scoreColumn, names, }) {
-    const splitLine = line.split('\t');
+function featureData2({ splitLine, refName, start, end, parser, uniqueId, scoreColumn, names, }) {
     const data = names
-        ? defaultParser(names, line)
-        : parser.parseLine(line, { uniqueId });
+        ? defaultParser(names, splitLine)
+        : parser.parseLine(splitLine, { uniqueId });
     const { strand: strand2, score: score2, chrom: _1, chromStart: _2, chromEnd: _3, ...rest } = data;
-    const { chromStarts, blockSizes, blockStarts, type, blockCount, thickStart, thickEnd, description, ...rest2 } = rest;
     const score = scoreColumn ? +data[scoreColumn] : score2 ? +score2 : undefined;
-    const strand = typeof strand2 === 'string' ? stringToStrand(strand2) : strand2;
-    const subfeatures = makeBlocks({
-        start,
-        uniqueId,
-        refName,
-        chromStarts,
-        blockCount,
-        blockSizes,
-        blockStarts,
-    });
+    const strand = typeof strand2 === 'string' ? (strand2 === '-' ? -1 : 1) : strand2;
+    const subfeatures = rest.blockCount
+        ? makeBlocks({
+            start,
+            uniqueId,
+            refName,
+            chromStarts: rest.chromStarts,
+            blockCount: rest.blockCount,
+            blockSizes: rest.blockSizes,
+            blockStarts: rest.blockStarts,
+        })
+        : undefined;
     if ((0, generateBedMethylFeature_1.isBedMethylFeature)({ splitLine, start, end })) {
         return (0, generateBedMethylFeature_1.generateBedMethylFeature)({
-            line,
+            splitLine,
             uniqueId,
             refName,
             start,
             end,
         });
     }
-    else if ((0, generateRepeatMaskerFeature_1.isRepeatMaskerDescriptionField)(description)) {
+    else if ((0, generateRepeatMaskerFeature_1.isRepeatMaskerDescriptionField)(rest.description)) {
+        const { chromStarts, blockSizes, blockStarts, type, blockCount, thickStart, thickEnd, description, ...rest2 } = rest;
         return (0, generateRepeatMaskerFeature_1.generateRepeatMaskerFeature)({
             ...rest2,
             uniqueId,
@@ -110,7 +110,13 @@ function featureData2({ line, refName, start, end, parser, uniqueId, scoreColumn
             subfeatures,
         });
     }
-    else if ((0, generateUcscTranscript_1.isUcscTranscript)({ strand, blockCount, thickStart })) {
+    else if (subfeatures &&
+        (0, generateUcscTranscript_1.isUcscTranscript)({
+            strand,
+            blockCount: rest.blockCount,
+            thickStart: rest.thickStart,
+        })) {
+        const { chromStarts, blockSizes, type, blockCount, thickStart, thickEnd, description, } = rest;
         return (0, generateUcscTranscript_1.generateUcscTranscript)({
             ...rest,
             description,
@@ -133,8 +139,6 @@ function featureData2({ line, refName, start, end, parser, uniqueId, scoreColumn
         return {
             ...rest,
             uniqueId,
-            description,
-            type,
             score,
             start,
             end,

package/esm/BedAdapter/BedAdapter.d.ts

@@ -1,7 +1,8 @@
-import BED from '@gmod/bed';
-import { BaseFeatureDataAdapter, BaseOptions } from '@jbrowse/core/data_adapters/BaseAdapter';
-import { Region, Feature } from '@jbrowse/core/util';
 import IntervalTree from '@flatten-js/interval-tree';
+import BED from '@gmod/bed';
+import { BaseFeatureDataAdapter } from '@jbrowse/core/data_adapters/BaseAdapter';
+import type { BaseOptions } from '@jbrowse/core/data_adapters/BaseAdapter';
+import type { Feature, Region } from '@jbrowse/core/util';
 export default class BedAdapter extends BaseFeatureDataAdapter {
     protected bedFeatures?: Promise<{
         header: string;
@@ -16,12 +17,21 @@ export default class BedAdapter extends BaseFeatureDataAdapter {
     protected intervalTrees: Record<string, Promise<IntervalTree | undefined> | undefined>;
     static capabilities: string[];
     private loadDataP;
-    private loadData;
+    loadData(opts?: BaseOptions): Promise<{
+        header: string;
+        features: Record<string, string[]>;
+        parser: BED;
+        columnNames: string[];
+        scoreColumn: string;
+        colRef: number;
+        colStart: number;
+        colEnd: number;
+    }>;
     getRefNames(opts?: BaseOptions): Promise<string[]>;
     getHeader(opts?: BaseOptions): Promise<string>;
     getNames(): Promise<string[] | undefined>;
     private loadFeatureIntervalTreeHelper;
-    private loadFeatureIntervalTree;
+    loadFeatureIntervalTree(refName: string): Promise<IntervalTree<any> | undefined>;
     getFeatures(query: Region, opts?: BaseOptions): import("rxjs").Observable<Feature>;
     freeResources(): void;
 }

package/esm/BedAdapter/BedAdapter.js

@@ -1,10 +1,9 @@
+import IntervalTree from '@flatten-js/interval-tree';
 import BED from '@gmod/bed';
-import { BaseFeatureDataAdapter, } from '@jbrowse/core/data_adapters/BaseAdapter';
+import { BaseFeatureDataAdapter } from '@jbrowse/core/data_adapters/BaseAdapter';
+import { SimpleFeature, fetchAndMaybeUnzip } from '@jbrowse/core/util';
 import { openLocation } from '@jbrowse/core/util/io';
 import { ObservableCreate } from '@jbrowse/core/util/rxjs';
-import { fetchAndMaybeUnzip, SimpleFeature, } from '@jbrowse/core/util';
-import IntervalTree from '@flatten-js/interval-tree';
-// locals
 import { featureData } from '../util';
 class BedAdapter extends BaseFeatureDataAdapter {
     constructor() {
@@ -15,7 +14,6 @@ class BedAdapter extends BaseFeatureDataAdapter {
         const pm = this.pluginManager;
         const bedLoc = this.getConf('bedLocation');
         const buffer = await fetchAndMaybeUnzip(openLocation(bedLoc, pm), opts);
-        // 512MB  max chrome string length is 512MB
         if (buffer.length > 536870888) {
             throw new Error('Data exceeds maximum string length (512MB)');
         }
@@ -94,9 +92,10 @@ class BedAdapter extends BaseFeatureDataAdapter {
         }
         const names = await this.getNames();
         const intervalTree = new IntervalTree();
-        const ret = lines.map((line, i) => {
+        for (let i = 0; i < lines.length; i++) {
+            const line = lines[i];
             const uniqueId = `${this.id}-${refName}-${i}`;
-            return new SimpleFeature(featureData({
+            const feat = new SimpleFeature(featureData({
                 line,
                 colRef,
                 colStart,
@@ -106,9 +105,7 @@ class BedAdapter extends BaseFeatureDataAdapter {
                 uniqueId,
                 names,
             }));
-        });
-        for (const obj of ret) {
-            intervalTree.insert([obj.get('start'), obj.get('end')], obj);
+            intervalTree.insert([feat.get('start'), feat.get('end')], feat);
         }
         return intervalTree;
     }
@@ -129,7 +126,7 @@ class BedAdapter extends BaseFeatureDataAdapter {
                 observer.next(f);
             });
             observer.complete();
-        }, opts.signal);
+        }, opts.stopToken);
     }
     freeResources() { }
 }

package/esm/BedAdapter/configSchema.d.ts

@@ -1,7 +1,4 @@
 declare const BedAdapter: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
-    /**
-     * #slot
-     */
     bedLocation: {
         type: string;
         defaultValue: {
@@ -9,49 +6,31 @@ declare const BedAdapter: import("@jbrowse/core/configuration/configurationSchem
             locationType: string;
         };
     };
-    /**
-     * #slot
-     */
     columnNames: {
         type: string;
         description: string;
         defaultValue: never[];
     };
-    /**
-     * #slot
-     */
     scoreColumn: {
         type: string;
         description: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     autoSql: {
         type: string;
         description: string;
         defaultValue: string;
     };
-    /**
-     * #slot
-     */
     colRef: {
         type: string;
         description: string;
         defaultValue: number;
     };
-    /**
-     * #slot
-     */
     colStart: {
         type: string;
         description: string;
         defaultValue: number;
     };
-    /**
-     * #slot
-     */
     colEnd: {
         type: string;
         description: string;

package/esm/BedAdapter/configSchema.js

@@ -1,59 +1,35 @@
 import { ConfigurationSchema } from '@jbrowse/core/configuration';
-/**
- * #config BedAdapter
- */
-function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
+function x() { }
 const BedAdapter = ConfigurationSchema('BedAdapter', {
-    /**
-     * #slot
-     */
     bedLocation: {
         type: 'fileLocation',
         defaultValue: { uri: '/path/to/my.bed.gz', locationType: 'UriLocation' },
     },
-    /**
-     * #slot
-     */
     columnNames: {
         type: 'stringArray',
         description: 'List of column names',
         defaultValue: [],
     },
-    /**
-     * #slot
-     */
     scoreColumn: {
         type: 'string',
         description: 'The column to use as a "score" attribute',
         defaultValue: '',
     },
-    /**
-     * #slot
-     */
     autoSql: {
         type: 'string',
         description: 'The autoSql definition for the data fields in the file',
         defaultValue: '',
     },
-    /**
-     * #slot
-     */
     colRef: {
         type: 'number',
         description: 'The column to use as a "refName" attribute',
         defaultValue: 0,
     },
-    /**
-     * #slot
-     */
     colStart: {
         type: 'number',
         description: 'The column to use as a "start" attribute',
         defaultValue: 1,
     },
-    /**
-     * #slot
-     */
     colEnd: {
         type: 'number',
         description: 'The column to use as a "end" attribute',

package/esm/BedAdapter/index.d.ts

@@ -1,2 +1,2 @@
-import PluginManager from '@jbrowse/core/PluginManager';
+import type PluginManager from '@jbrowse/core/PluginManager';
 export default function BedAdapterF(pluginManager: PluginManager): void;

package/esm/BedGraphAdapter/BedGraphAdapter.d.ts

@@ -0,0 +1,24 @@
+import IntervalTree from '@flatten-js/interval-tree';
+import { BaseFeatureDataAdapter } from '@jbrowse/core/data_adapters/BaseAdapter';
+import type { BaseOptions } from '@jbrowse/core/data_adapters/BaseAdapter';
+import type { Feature, Region } from '@jbrowse/core/util';
+export default class BedGraphAdapter extends BaseFeatureDataAdapter {
+    protected bedFeatures?: Promise<{
+        header: string;
+        features: Record<string, string[]>;
+        columnNames: string[];
+    }>;
+    protected intervalTrees: Record<string, Promise<IntervalTree | undefined> | undefined>;
+    getNames(): Promise<string[] | undefined>;
+    private loadFeatureIntervalTreeHelper;
+    getRefNames(opts?: BaseOptions): Promise<string[]>;
+    private loadDataP;
+    loadFeatureIntervalTree(refName: string): Promise<IntervalTree<any> | undefined>;
+    loadData(opts?: BaseOptions): Promise<{
+        header: string;
+        features: Record<string, string[]>;
+        columnNames: string[];
+    }>;
+    getFeatures(query: Region, _opts?: BaseOptions): import("rxjs").Observable<Feature>;
+    freeResources(): void;
+}

package/esm/BedGraphAdapter/BedGraphAdapter.js

@@ -0,0 +1,124 @@
+import IntervalTree from '@flatten-js/interval-tree';
+import { BaseFeatureDataAdapter } from '@jbrowse/core/data_adapters/BaseAdapter';
+import { SimpleFeature, fetchAndMaybeUnzip } from '@jbrowse/core/util';
+import { openLocation } from '@jbrowse/core/util/io';
+import { ObservableCreate } from '@jbrowse/core/util/rxjs';
+export default class BedGraphAdapter extends BaseFeatureDataAdapter {
+    constructor() {
+        super(...arguments);
+        this.intervalTrees = {};
+    }
+    async getNames() {
+        const { header, columnNames } = await this.loadData();
+        if (columnNames.length) {
+            return columnNames;
+        }
+        const defs = header.split(/\n|\r\n|\r/).filter(f => !!f);
+        const defline = defs.at(-1);
+        return (defline === null || defline === void 0 ? void 0 : defline.includes('\t'))
+            ? defline
+                .slice(1)
+                .split('\t')
+                .map(field => field.trim())
+            : undefined;
+    }
+    async loadFeatureIntervalTreeHelper(refName) {
+        var _a;
+        const { features } = await this.loadData();
+        const lines = features[refName];
+        if (!lines) {
+            return undefined;
+        }
+        const names = ((_a = (await this.getNames())) === null || _a === void 0 ? void 0 : _a.slice(3)) || [];
+        const intervalTree = new IntervalTree();
+        for (let i = 0; i < lines.length; i++) {
+            const line = lines[i];
+            const [refName, s, e, ...rest] = line.split('\t');
+            for (let j = 0; j < rest.length; j++) {
+                const uniqueId = `${this.id}-${refName}-${i}-${j}`;
+                const start = +s;
+                const end = +e;
+                const score = +rest[j];
+                const source = names[j] || `col${j}`;
+                if (score) {
+                    intervalTree.insert([start, end], new SimpleFeature({
+                        id: uniqueId,
+                        data: {
+                            refName,
+                            start,
+                            end,
+                            score,
+                            source,
+                        },
+                    }));
+                }
+            }
+        }
+        return intervalTree;
+    }
+    async getRefNames(opts = {}) {
+        const { features } = await this.loadData(opts);
+        return Object.keys(features);
+    }
+    async loadDataP(opts = {}) {
+        const pm = this.pluginManager;
+        const bedLoc = this.getConf('bedGraphLocation');
+        const buffer = await fetchAndMaybeUnzip(openLocation(bedLoc, pm), opts);
+        if (buffer.length > 536870888) {
+            throw new Error('Data exceeds maximum string length (512MB)');
+        }
+        const data = new TextDecoder('utf8', { fatal: true }).decode(buffer);
+        const lines = data.split(/\n|\r\n|\r/).filter(f => !!f);
+        const headerLines = [];
+        let i = 0;
+        for (; i < lines.length && lines[i].startsWith('#'); i++) {
+            headerLines.push(lines[i]);
+        }
+        const header = headerLines.join('\n');
+        const features = {};
+        for (; i < lines.length; i++) {
+            const line = lines[i];
+            const tab = line.indexOf('\t');
+            const refName = line.slice(0, tab);
+            if (!features[refName]) {
+                features[refName] = [];
+            }
+            features[refName].push(line);
+        }
+        const columnNames = this.getConf('columnNames');
+        return {
+            header,
+            features,
+            columnNames,
+        };
+    }
+    async loadFeatureIntervalTree(refName) {
+        if (!this.intervalTrees[refName]) {
+            this.intervalTrees[refName] = this.loadFeatureIntervalTreeHelper(refName).catch((e) => {
+                this.intervalTrees[refName] = undefined;
+                throw e;
+            });
+        }
+        return this.intervalTrees[refName];
+    }
+    async loadData(opts = {}) {
+        if (!this.bedFeatures) {
+            this.bedFeatures = this.loadDataP(opts).catch((e) => {
+                this.bedFeatures = undefined;
+                throw e;
+            });
+        }
+        return this.bedFeatures;
+    }
+    getFeatures(query, _opts = {}) {
+        return ObservableCreate(async (observer) => {
+            const { start, end, refName } = query;
+            const intervalTree = await this.loadFeatureIntervalTree(refName);
+            intervalTree === null || intervalTree === void 0 ? void 0 : intervalTree.search([start, end]).forEach(f => {
+                observer.next(f);
+            });
+            observer.complete();
+        });
+    }
+    freeResources() { }
+}

package/esm/BedGraphAdapter/configSchema.d.ts

@@ -0,0 +1,15 @@
+declare const BedGraphAdapter: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+    bedGraphLocation: {
+        type: string;
+        defaultValue: {
+            uri: string;
+            locationType: string;
+        };
+    };
+    columnNames: {
+        type: string;
+        description: string;
+        defaultValue: never[];
+    };
+}, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
+export default BedGraphAdapter;

package/esm/BedGraphAdapter/configSchema.js

@@ -0,0 +1,17 @@
+import { ConfigurationSchema } from '@jbrowse/core/configuration';
+function x() { }
+const BedGraphAdapter = ConfigurationSchema('BedGraphAdapter', {
+    bedGraphLocation: {
+        type: 'fileLocation',
+        defaultValue: {
+            uri: '/path/to/my.bedgraph',
+            locationType: 'UriLocation',
+        },
+    },
+    columnNames: {
+        type: 'stringArray',
+        description: 'List of column names',
+        defaultValue: [],
+    },
+}, { explicitlyTyped: true });
+export default BedGraphAdapter;

package/esm/BedGraphAdapter/index.d.ts

@@ -0,0 +1,2 @@
+import type PluginManager from '@jbrowse/core/PluginManager';
+export default function BedGraphAdapterF(pluginManager: PluginManager): void;

package/esm/BedGraphAdapter/index.js

@@ -0,0 +1,10 @@
+import AdapterType from '@jbrowse/core/pluggableElementTypes/AdapterType';
+import configSchema from './configSchema';
+export default function BedGraphAdapterF(pluginManager) {
+    pluginManager.addAdapterType(() => new AdapterType({
+        name: 'BedGraphAdapter',
+        displayName: 'BedGraph adapter',
+        configSchema,
+        getAdapterClass: () => import('./BedGraphAdapter').then(r => r.default),
+    }));
+}

package/esm/BedGraphTabixAdapter/BedGraphTabixAdapter.d.ts

@@ -0,0 +1,18 @@
+import { TabixIndexedFile } from '@gmod/tabix';
+import { BaseFeatureDataAdapter } from '@jbrowse/core/data_adapters/BaseAdapter';
+import type { BaseOptions } from '@jbrowse/core/data_adapters/BaseAdapter';
+import type { Feature, Region } from '@jbrowse/core/util';
+export default class BedGraphAdapter extends BaseFeatureDataAdapter {
+    private configured?;
+    private configurePre;
+    protected configure(): Promise<{
+        bedGraph: TabixIndexedFile;
+        header: string;
+        columnNames: string[];
+    }>;
+    getNames(): Promise<string[] | undefined>;
+    getRefNames(opts?: BaseOptions): Promise<string[]>;
+    getHeader(): Promise<string>;
+    getFeatures(query: Region, opts?: BaseOptions): import("rxjs").Observable<Feature>;
+    freeResources(): void;
+}