{"_id":"@apr144/higlass-bigwig-datafetcher","_rev":"1-9ef49ee5388b7bafd2272d26a6dfef66","name":"@apr144/higlass-bigwig-datafetcher","dist-tags":{"latest":"0.2.0-020925-001"},"versions":{"0.2.0":{"name":"@apr144/higlass-bigwig-datafetcher","version":"0.2.0","author":{"name":"Alexander Veit"},"license":"MIT","_id":"@apr144/higlass-bigwig-datafetcher@0.2.0","maintainers":[{"name":"apr144","email":"alexpreynolds@gmail.com"}],"contributors":[{"url":"http://github.com/alexander-veit","name":"Alexander Veit"},{"url":"https://github.com/alexpreynolds","name":"Alex Reynolds"}],"homepage":"https://github.com/higlass/higlass-bigwig-datafetcher#readme","bugs":{"url":"https://github.com/higlass/higlass-bigwig-datafetcher/issues"},"dist":{"shasum":"d3e3c61e3233b00b3bceba6f9ff30bdb172cf2b6","tarball":"https://registry.npmjs.org/@apr144/higlass-bigwig-datafetcher/-/higlass-bigwig-datafetcher-0.2.0.tgz","fileCount":5,"integrity":"sha512-9AMO6FgMNqYQHZh2BnVby62S4MK80FjGXAFB3SRFF8p5I/OVMZrL4MnkKFOnQcf1FWriGxYirt5H3S8LnkvX3g==","signatures":[{"sig":"MEUCIQDCZEEW0lpOwAV++sCfMYVzNi9tiKZn2J1cTMZpIwfWIAIgVsdjxYVGJi3WwxPzkQRZmfv1avMSZFK/2/+fQ7Mzu6k=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":15956},"main":"dist/index.js","type":"module","module":"dist/index.js","exports":{".":{"import":"./dist/index.js"}},"gitHead":"03f194476433cd57234d8ac8e3ecba0e68590ca1","private":false,"scripts":{"test":"vitest --config vite-test.config.js --run","build":"rimraf ./dist/ && npm run build-lib","start":"npm-run-all --parallel start-lib start-app","build-lib":"npm run build-lib:prod && npm run build-lib:dev","start-app":"vite --config vite-demo.config.js --port 3000","start-lib":"cross-env ESBUILD_MODE=watch node ./bundle.mjs","prerelease":"rm -rf dist/*; npm run build; zip -r dist.zip dist","test-watch":"vitest --config vite-test.config.js --watch","build-lib:dev":"cross-env APP_ENV=development ESBUILD_MODE=build node ./bundle.mjs","build-lib:prod":"cross-env APP_ENV=production ESBUILD_MODE=build node ./bundle.mjs"},"_npmUser":{"name":"apr144","email":"alexpreynolds@gmail.com"},"repository":{"url":"git://github.com/higlass/higlass-bigwig-datafetcher.git","type":"git"},"_npmVersion":"10.1.0","description":"Bigwig Data Fetcher for HiGlass","directories":{},"_nodeVersion":"20.9.0","dependencies":{"d3-dsv":"^3.0.1","slugid":"^3.0.0","d3-scale":"^1.0.7","@gmod/bbi":"^3.0.1","d3-request":"^1.0.6","higlass-register":"^0.3.0","@apr144/generic-filehandle":"3.1.1-020925-001"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^4.3.0","jsdom":"^20.0.0","rimraf":"^3.0.2","vitest":"^0.23.4","esbuild":"^0.14.42","cross-env":"^7.0.0","npm-run-all":"^4.1.5","@esbuild-plugins/node-globals-polyfill":"^0.1.1","@esbuild-plugins/node-modules-polyfill":"^0.1.4"},"_npmOperationalInternal":{"tmp":"tmp/higlass-bigwig-datafetcher_0.2.0_1739147532727_0.059831771231231956","host":"s3://npm-registry-packages-npm-production"}},"0.2.0-020925-001":{"name":"@apr144/higlass-bigwig-datafetcher","version":"0.2.0-020925-001","description":"Bigwig Data Fetcher for HiGlass","private":false,"author":{"name":"Alexander Veit"},"license":"MIT","contributors":[{"name":"Alexander Veit","url":"http://github.com/alexander-veit"},{"name":"Alex Reynolds","url":"https://github.com/alexpreynolds"}],"type":"module","main":"dist/index.js","module":"dist/index.js","exports":{".":{"import":"./dist/index.js"}},"repository":{"type":"git","url":"git://github.com/higlass/higlass-bigwig-datafetcher.git"},"devDependencies":{"rimraf":"^3.0.2","cross-env":"^7.0.0","esbuild":"^0.14.42","@esbuild-plugins/node-globals-polyfill":"^0.1.1","@esbuild-plugins/node-modules-polyfill":"^0.1.4","jsdom":"^20.0.0","vite":"^4.3.0","vitest":"^0.23.4","npm-run-all":"^4.1.5"},"scripts":{"build":"rimraf ./dist/ && npm run build-lib","build-lib":"npm run build-lib:prod && npm run build-lib:dev","build-lib:prod":"cross-env APP_ENV=production ESBUILD_MODE=build node ./bundle.mjs","build-lib:dev":"cross-env APP_ENV=development ESBUILD_MODE=build node ./bundle.mjs","start-lib":"cross-env ESBUILD_MODE=watch node ./bundle.mjs","start-app":"vite --config vite-demo.config.js --port 3000","start":"npm-run-all --parallel start-lib start-app","prerelease":"rm -rf dist/*; npm run build; zip -r dist.zip dist","test-watch":"vitest --config vite-test.config.js --watch","test":"vitest --config vite-test.config.js --run"},"dependencies":{"@gmod/bbi":"^3.0.1","@apr144/generic-filehandle":"3.1.1-020925-001","d3-scale":"^1.0.7","d3-dsv":"^3.0.1","d3-request":"^1.0.6","higlass-register":"^0.3.0","slugid":"^3.0.0"},"gitHead":"60180981ccde55035dfd54167c4e2b5c7c34fbce","bugs":{"url":"https://github.com/higlass/higlass-bigwig-datafetcher/issues"},"homepage":"https://github.com/higlass/higlass-bigwig-datafetcher#readme","_id":"@apr144/higlass-bigwig-datafetcher@0.2.0-020925-001","_nodeVersion":"16.20.2","_npmVersion":"8.19.4","dist":{"integrity":"sha512-Dr+43XNuA97N6KO4YlKZTAcJkhuQtYIoDooNCywkt2KE5Op5fws4m93KGomMS9ZKD1TdhF/w3rdmGxR9Y8g6bQ==","shasum":"9775048ded72a7c0c86eaf445c8be4ab6336e926","tarball":"https://registry.npmjs.org/@apr144/higlass-bigwig-datafetcher/-/higlass-bigwig-datafetcher-0.2.0-020925-001.tgz","fileCount":9,"unpackedSize":2116480,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDY77F2O5YH3jHRBT/fHq5P6SLSf2PfwbEY9qjzBc7rogIgLWaxxKKIJRNmule8OGpcR5K2VhNU1vDRBM9c/QzrB8o="}]},"_npmUser":{"name":"apr144","email":"alexpreynolds@gmail.com"},"directories":{},"maintainers":[{"name":"apr144","email":"alexpreynolds@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/higlass-bigwig-datafetcher_0.2.0-020925-001_1739149580103_0.20263554566639375"},"_hasShrinkwrap":false}},"time":{"created":"2025-02-10T00:32:12.629Z","modified":"2025-02-10T01:06:20.609Z","0.2.0":"2025-02-10T00:32:12.933Z","0.2.0-020925-001":"2025-02-10T01:06:20.426Z"},"bugs":{"url":"https://github.com/higlass/higlass-bigwig-datafetcher/issues"},"author":{"name":"Alexander Veit"},"license":"MIT","homepage":"https://github.com/higlass/higlass-bigwig-datafetcher#readme","repository":{"type":"git","url":"git://github.com/higlass/higlass-bigwig-datafetcher.git"},"description":"Bigwig Data Fetcher for HiGlass","contributors":[{"name":"Alexander Veit","url":"http://github.com/alexander-veit"},{"name":"Alex Reynolds","url":"https://github.com/alexpreynolds"}],"maintainers":[{"name":"apr144","email":"alexpreynolds@gmail.com"}],"readme":"# BigWig Data Fetcher for HiGlass\n\nQuickly load data from a bigwig file in HiGlass.\n\n[![HiGlass](https://img.shields.io/badge/higlass-🌸-brightgreen.svg)](http://higlass.io)\n\n\n## Usage\n\nThe live scripts can be found at:\n\n- https://unpkg.com/higlass-bigwig-datafetcher/dist/higlass-bigwig-datafetcher.min.js\n\nFirst, register the data fetcher:\n\n```js\nimport register from \"higlass-register\";\nimport { BigwigDataFetcher } from \"higlass-bigwig-datafetcher\";\n\nregister(\n  { dataFetcher: BigwigDataFetcher, config: BigwigDataFetcher.config },\n  { pluginType: \"dataFetcher\" }\n);\n```\n\nConfigure the track in your view config; you should be all set from here!\n\n```\n[...\n  {\n    \"type\": \"bar\",\n    \"height\": 80,\n    \"data\": {\n      \"type\": \"bbi\",\n      \"url\": \"https://aveit.s3.amazonaws.com/higlass/bigwig/example.chr1.10000-1160000.bw\",\n      \"chromSizesUrl\": \"https://aveit.s3.amazonaws.com/higlass/data/sequence/hg38.chrom.sizes\",\n    },\n    \"options\": {\n      ...\n    }\n    \n  }\n]\n```\n\nNote that the `chromSizesUrl` option is required.\n\nFor an example, see [`src/index.html`](src/index.html).\n\n### Basic authentication\n\nBigwig files may be hosted on a website that uses Basic authentication to limit access. To load data from a bigWig file hosted on a site that uses Basic authentication, add the username and password to the URL. For example: `http://username:password@example.com/data.bw`. This would be used in the view configuration `url` property, *e.g.*,:\n\n```\n[...\n  {\n    \"type\": \"bar\",\n    \"height\": 80,\n    \"data\": {\n      \"type\": \"bbi\",\n      \"url\": \"http://username:password@example.com/data.bw\",\n      \"chromSizesUrl\": \"https://aveit.s3.amazonaws.com/higlass/data/sequence/hg38.chrom.sizes\",\n    },\n    \"options\": {\n      ...\n    }\n    \n  }\n]\n```\n\n## Development\n\n### Testing\n\nTo run the test suite:\n\n```\nnpm run test\n```\n\n### Installation\n\n```bash\n$ git clone https://github.com/higlass/higlass-bigwig-datafetcher\n$ cd higlass-bigwig-datafetcher\n$ npm install\n```\n\nIf you have a local copy of higlass, you can then run this command in the higlass-bigwig-datafetcher directory:\n\n```bash\nnpm link higlass\n```\n\n### Commands\n\n- **Developmental server**: `npm start`\n- **Production build**: `npm run build`\n","readmeFilename":"README.md"}