kegg-db
v0.0.7
Published
JavaScript wrapper to the KEGG Database API
Downloads
8
Maintainers
Readme
KEGG API
A JavaScript wrapper for the KEGG biological database. Results are returned as JSON objects, see below for structure details. There are license restrictions on the use of KEGG, along with other guidelines. Please check at http://www.kegg.jp/kegg/ to make sure you use the system appropriately.
Installation
npm install kegg-db --save
Usage
const KEGG = require('kegg-db');
KEGG.getReactionById("R04573", function(data) {
...
});
Due to HTTPS and CORS restrictions in a browser you may need to proxy the database. Set the new database URL using:
KEGG.options({url: "http://..."});
Documentation
- KEGG
.findReaction(query {string}, callback {function (data)})
Result data is an array of objects with:
id
- KEGG reaction ID numbername
- Human readable reaction name
.findCompound(query {string}, callback {function (data)})
Result data is an array of objects with:
id
- KEGG compound ID numbername
- Human readable compound name
.findCompoundByFormula(query {string}, callback {function (data)})
Result data is an array of objects with:
id
- KEGG compound ID numbername
- Human readable compound name
.findCompoundByWeight(query {string}, callback {function (data)})
Result data is an array of objects with:
id
- KEGG compound ID numbername
- Human readable compound name
.findCompoundByMass(query {string}, callback {function (data)})
Result data is an array of objects with:
id
- KEGG compound ID numbername
- Human readable compound name
.findGene(query {string}, callback {function (data)})
.findEnzyme(query {string}, callback {function (data)})
Result data is an array of objects with:
id
- EC enzyme numbername
- Human readable enzyme name
.getReactionById(id {string}, callback {function (data)})
Reaction data object:
names
- Array of name stringsdefinition
- Human readable reaction equationequation
- Equation using KEGG id's for compoundsenzyme
- EC numberpathways
- Array of associated pathwaysrclasses
- Object
.getCompoundById(id {string}, callback {function (data)})
Compound data object:
names
- Array of name stringsformula
- Chemical formulaexact_mass
- Floatmol_weight
- Floatreactions
- Array of associated KEGG reaction numberspathways
- Array of associated pathwaysenzymes
- Array of enyzyme EC numbersdblinks
- Object to convert ID
.getGeneById(id {string}, callback {function (data)})
.getEnzymeById(ec {string}, callback {function (data)})
Enzyme data object:
names
- Array of name stringsclasses
- Array of class stringssysname
- Stringreaction
- Human readable reactionreactions
- Array of associated KEGG reaction IDssubstrates
- Array of substrate compound IDsproducts
- Array of product compound IDscomment
- Stringgenes
- Object where keys are organism code, values are gene number(s)