Skip to content

Commit

Permalink
Change README doc again
Browse files Browse the repository at this point in the history
  • Loading branch information
knicos committed Nov 23, 2017
1 parent 5a57300 commit 860ca61
Showing 1 changed file with 41 additions and 56 deletions.
97 changes: 41 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,85 +26,70 @@ KEGG.options({url: "http://..."});

## Documentation

### `findReaction(query {string}, callback {function (data)})`
### `.findReaction(query {string}, callback {function (data)})`
Result data is an array of objects with:
* `id` - KEGG reaction ID number
* `name` - Human readable reaction name

### `findCompound(query {string}, callback {function (data)})`
### `.findCompound(query {string}, callback {function (data)})`
Result data is an array of objects with:
* `id` - KEGG compound ID number
* `name` - Human readable compound name

### `findCompoundByFormula(query {string}, callback {function (data)})`
### `.findCompoundByFormula(query {string}, callback {function (data)})`
Result data is an array of objects with:
* `id` - KEGG compound ID number
* `name` - Human readable compound name

### `findCompoundByWeight(query {string}, callback {function (data)})`
### `.findCompoundByWeight(query {string}, callback {function (data)})`
Result data is an array of objects with:
* `id` - KEGG compound ID number
* `name` - Human readable compound name

### `findCompoundByMass(query {string}, callback {function (data)})`
### `.findCompoundByMass(query {string}, callback {function (data)})`
Result data is an array of objects with:
* `id` - KEGG compound ID number
* `name` - Human readable compound name

### `findGene(query {string}, callback {function (data)})`
### `.findGene(query {string}, callback {function (data)})`

### `findEnzyme(query {string}, callback {function (data)})`
### `.findEnzyme(query {string}, callback {function (data)})`
Result data is an array of objects with:
* `id` - EC enzyme number
* `name` - Human readable enzyme name

### getReactionById
* id - KEGG reaction ID, eg. "R04573"
* callback - Function with one parameter for returned data

The callback may have a null parameter if there was no match.

Reaction Object:
* names - Array of name strings
* definition - Human readable reaction equation
* equation - Equation using KEGG id's for compounds
* enzyme - EC number
* pathways - Array of associated pathways
* rclasses - Object

### getCompoundById
* id - KEGG compound ID, eg. "C00008"
* callback - Function with one parameter for returned data

Compound Object:
* names - Array of name strings
* formula - Chemical formula
* exact_mass - Float
* mol_weight - Float
* reactions - Array of associated KEGG reaction numbers
* pathways - Array of associated pathways
* enzymes - Array of enyzyme EC numbers
* dblinks - Object to convert ID

### getGeneById
* id - gene ID, eg. "slr1351"
* callback - Function with one parameter for returned data

Gene Object:


### getEnzymeById
* id - Enzyme EC number, eg. "6.3.2.10"
* callback - Function with one parameter for returned data

Enzyme Object:
* names - Array of name strings
* classes - Array of class strings
* sysname - String
* reaction - Human readable reaction
* reactions - Array of associated KEGG reaction IDs
* substrates - Array of substrate compound IDs
* products - Array of product compound IDs
* comment - String
* genes - Object where keys are organism code, values are gene number(s)
### `.getReactionById(id {string}, callback {function (data)})`
Reaction data object:
* `names` - Array of name strings
* `definition` - Human readable reaction equation
* `equation` - Equation using KEGG id's for compounds
* `enzyme` - EC number
* `pathways` - Array of associated pathways
* `rclasses` - Object

### `.getCompoundById(id {string}, callback {function (data)})`
Compound data object:
* `names` - Array of name strings
* `formula` - Chemical formula
* `exact_mass` - Float
* `mol_weight` - Float
* `reactions` - Array of associated KEGG reaction numbers
* `pathways` - Array of associated pathways
* `enzymes` - Array of enyzyme EC numbers
* `dblinks` - Object to convert ID

### `.getGeneById(id {string}, callback {function (data)})`


### `.getEnzymeById(ec {string}, callback {function (data)})`
Enzyme data object:
* `names` - Array of name strings
* `classes` - Array of class strings
* `sysname` - String
* `reaction` - Human readable reaction
* `reactions` - Array of associated KEGG reaction IDs
* `substrates` - Array of substrate compound IDs
* `products` - Array of product compound IDs
* `comment` - String
* `genes` - Object where keys are organism code, values are gene number(s)

0 comments on commit 860ca61

Please sign in to comment.