This module is part of the Bond University Centre for Research in Evidence-Based Practice Systematic Review Assistant suite of tools.
When supplied with a single or multiple references this module will attempt to resolve the URL to the paper via a number of difference sources.
var Forager = require('sra-forager');
var forage = new Forager();
forage.populate('10.1016/S0092-8674(00)81683-9', function(err, urls) {
// Urls should now be an object containing the URLs of the citations from various databases
});Sources can be found in the ./drivers directory as independent modules.
- bondLibrary - Search via the Bond University Library
- doi - Simple link to the paper on the DOI.org website (this really just glues the DOI of the paper to the doi.org url)
- doiDx - The resolved URL of the paper
- google - A simple Google search
- googleScholar - A simple search using Google Scholar
- wos - Web of Science (requires username / password). This search returns the URL on WoS, a link to related papers and a link to what this paper cites
forger.populate(reference, [options], callback)
Provide a list of URLs to access the given reference. If the reference is provided as a string it will be assumed to be a DOI otherwise it must be provided as a RefLib compatible citation.
forager.fields(callback)
Calculate the fields that forager would return as an object.
forager.set(options Object)
forager.set(key, value)
Set one or more options relative to the forager instance. If specified as a key this can be in dotted notation or as an array of branches.
Each driver must expose at least a populate function which, similar to the main module, must accept a reference (which will always be an object, which may have an optional doi key), settings (always an object) and a callback.
The async populate function can then return either a string or an object if the population will return multiple keys.
The driver modules can also return a fields function which should return a key/value object describing what the returned keys actually are.
See the drivers directory for examples.