@gmod/bed - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

CHANGELOG.md

@@ -0,1 +1,8 @@
+## [1.0.3](https://github.com/GMOD/bed-js/compare/v1.0.2...v1.0.3) (2019-04-02)
+
+
+
+- Fix usage of autoSql
+- Use commonjs2 target of the webpack library build
+
 ## [1.0.2](https://github.com/GMOD/bed-js/compare/v1.0.1...v1.0.2) (2019-04-02)
@@ -2,0 +9,0 @@

package.json

 {
   "name": "@gmod/bed",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A BED file format parser with autoSql support",
@@ -5,0 +5,0 @@ "main": "dist/main.js",

README.md

@@ -91,4 +91,5 @@ # bed-js
 
-If you have a BED format with a custom alternative schema with autoSql, or if you are using a BigBed file that contains autoSql (e.g. with [@gmod/bbi](https://github.com/gmod/bbi-js) then you can get it from header.autoSql) then you can supply this via the constructor
+If you have a BED format with a custom alternative schema with autoSql, or if you are using a BigBed file that contains autoSql (e.g. with [@gmod/bbi](https://github.com/gmod/bbi-js) then you can get it from header.autoSql)
 
+
 ```
@@ -100,9 +101,23 @@ const p = new BED({ autoSql: /* your autosql formatted string here */ })
 
+If you want to use BigBed, you can get it's autoSql and use it in the BED parser
 
+```js
+import {BigBed} from @gmod/bbi
+const ti = new BigBed({ path: 'yourfile.bb' }) // note: use url for remote resource, or filehandle for custom resource
+const {autoSql} = await ti.getHeader()
+const parser = new BED({ autoSql })
+const lines = await ti.getFeatures('chr1', 0, 10000)
+const feats = lines.map(l => parser.parseBedText(l.refID, l.start, l.end, l.rest))
+```
+
+
+
+
 ### Important notes
 
 
-* BED parsing does not do any conversion of types beyond string vs int but helps assign keys to values
-* Parsing does not convert blockStarts/blockEnds to gene features
-* It does not parse header or track lines
+* Does not do any conversion of types beyond just converting known int/float values
+* Does not convert blockStarts/blockEnds to gene features
+* Does not parse header or track lines
+* Does not handle files that use spaces instead of tabs even though this is allowed by UCSC
 
@@ -109,0 +124,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

308184

increased by108.57%

Lines of code

7985

increased byInfinity%

Number of lines in readme file

131

increased by12.93%

No dependency changes