0.1.0-0 • Published 4 years ago
bitk-headers v0.1.0-0
bitk-headers
A library to support headers compatible with BITK's standard. Written in TypeScript.
Install
npm install bitk-headersVersions
BitkHeader version 3
The newest version of BitkHeaders follows the implementation of stable genes ids from MiST3. This version cannot be translated to Version 1 or 2 (see below) because it does not have the legacy MiST2 genome ids. However, versions 1 and 2 can be translated to this version with access to the MiST3 API.
Version 3: Xx_yyy|genome_ncbi_version-locus|extra fields`
Example: My_xan|GCF_000012685.1-MXAN_RS12980
| item | Description |
|---|---|
Xx | First two letter of genus |
yyy | First three letters of species |
genome_ncbi_version | NCBI genome version code |
locus | Locus number of the gene |
extra fields | any other annotation needed: classifications and etc. |
BitkHeaderLegacy version 1 and 2
Version 1: Xx.yyy.NNN-locus-accession-extra fields
Example: My.xan.508-MXAN_2680-YP_630897.1
Version 2: Xx_yyy_NNN|locus|accession|extra fields
Example: My.xan.508-MXAN_2680-YP_630897.1
| item | Description |
|---|---|
Xx | First two letter of genus |
yyy | First three letters of species |
NNN | MiST2 genome id |
locus | Locus number of the gene |
accession | NCBI accession number |
extra fields | any other annotation needed: classifications and etc. |
Developer's Documentation
... to be continued.
Written with ❤ in Typescript.