gramene-trees-client's Introduction

gramene-trees-client

Provide convenient API for trees. Currently only used for NCBI taxonomy data.

Installation

You need to pull down the package via npm. You also can use yarn.

npm install gramene-trees-client --save

##Usage

###Promises

 var  treeLoader = grameneTreesClient.promise;
        treeLoader.get().then(function(taxonomy) {
            console.log(taxonomy.model);
        }).catch(function(error) {
            console.error("Error in getting data: ");
        });

Promises-functionality can be obtained from transpilers like babel.js or a library like a library like q

###Await/Async

var treeLoader = require("gramene-trees-client").promise;
var taxonomy = await treeLoader.get();

console.log(taxonomy.model)

Await/Async functionaltiy can be be obtained from transpilers like babel.js or a library like asyncawait. Note, with the asyncawait library, the await and async are functions rather than keywords.

This can be adapted to work in ES2015+ via a transpiler or browsers with native support like in Chrome

gramene-trees-client's People

Contributors

Watchers

gramene-trees-client's Issues

Need more installation instruction

There needs to be instructions on how to install and use this.

pruneTree currently takes a map with taxon_id keys to decide which nodes to keep in a tree. Instead, it should accept a function that decides whether to keep a node in the tree or to discard the subtree rooted at this node.

This will allow a user to, for example, cut a node from a genetree if it is intruding excessive gaps in the multiple alignment.

Provide useful error message if a null/undefined node is provided to LCA function

Currently an obscure implementation-specific error is thrown ('getPath is not a function') if an undefined or null node is passed in to tree.lca or node.lcaWith.

Instead, throw error with message "Cannot calculate lca with a null node".

Recommend Projects