node-ncbi

node-ncbi

A nodejs wrapper for the NCBI eUtils. You can use it to search PubMed or other databases and get the results as a JavaScript object.

Read the full documentation of eUtils.

Note: Browser use isn't ideal right now due to the very large XML parser. I'll come with a dedicated script that relies on the browser's native DOM parsing to get around this.

Getting started

npm install --save node-ncbi

var ncbi = require('node-ncbi');

Basic usage

Performing a search

const pubmed = ncbi.pubmed;
pubmed.search('actin').then((results) => {
    console.log(results);
});

Will log

{
  count: (Number),
  papers: (Array)
}

where count is the total number of papers, independent of pagination. The "papers" represent PubMed "summaries" containing title, authors, journal and citation information, etc..

By default, 10 results will be retrieved at a time. To get the next set of results:

pubmed.search('actin', 1).then((results) => {
    console.log(results);
});

To change the number of results retrieved at a time:

pubmed.search('actin', 0, 20).then((results) => {
    console.log(results);
});

###Looking up a specific paper

pubmed.summary(20517925).then((paper) => {
  console.log(paper);
});

where the only argument is a PMID (PubMed ID #).

In addition, following methods are available:

• abstract() - get the abstract
• summary() - get the "summary" - an object of fields containing title, authors, citation info, etc.
• cites() - papers which this paper cites.
• citedBy() - papers which cite this paper (only includes citing papers in PubMed central)
• similar() - papers similar to this one (similarity is calculated on NCBI's side of the API, not ours).

All methods return a promise accessible by .then(). Except for .abstract() the parameter passed to the callback is a PubMed summary or an array of summaries.

Contributing

I'd love to get PRs improving the code or expanding the search methods beyond PubMed.

You can build for development by navigating to the project folder and running npm install. You'll also need to have gulp installed globally npm install -g gulp.

REPL

To help with creating Gateways are seeing the data structures returned by the API, node-ncbi provides a custom REPL. Start it with npm start. You can then run url({object}) or open({object}) where {object} is an object literal that looks like the following:

utility: 'esearch',
params: {
  db: 'pubmed',
  term: query,
  retstart: start,
  retmax: resultsPerPage
}

url will log the URL needed to access eUtils while open will open that URL in a browser. This can help with debugging and to look at the actual data which is useful to create new queries. See the full documentation of eUtils for more information on creating queries.

ESLint

Run with gulp lint.

License

Copyright (c) 2016 Casey A. Ydenberg

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.