rAltmetric (version 0.6)

altmetrics: Grab altmetric data on any paper

Description

This function will retrieve data from Altmetric.com on any paper with an appropriate object identifier. Acceptable identifiers include dois, arXiv ids, pubmed ids and altmetric ids.

Usage

altmetrics(oid = NULL, id = NULL, doi = NULL, pmid = NULL, arXiv = NULL, apikey = getOption("altmetricKey"), curl = getCurlHandle(), ...)

Arguments

oid

oid Any object ID. Any general object identifier as long as the prefix is "doi","pmid", "arXiv", or "id".

id

The Altmetric id of a paper. If specifiying directly, the "id" prefix is not necessary.

doi

The doi of a paper. If specifiying directly, the "doi" prefix is not necessary.

pmid

The pmid of a paper.If specifiying directly, the "pmid" prefix is not necessary.

arXiv

The arxiv ID of a paper.If specifiying directly, the "arXiv" prefix is not necessary.

apikey

An API key obtained from altmetric. The key for this application is '37c9ae22b7979124ea650f3412255bf9' and you are free to use it for academic non-commercial research. But if you start seeing rate limits, please contact support at altmetric.com to get your own.

The function returns detailed metrics. For more information on all the fields returned by the function, see the API documentation: (http://api.altmetric.com/docs/call_citations.html). If you get your own key, you can save it in your .rprofile as options(altmetricKey="YOUR_KEY")

curl

passes on curl handle in a vectorized operation

...

additional parameters

Value

list

Examples

## Not run: 
# altmetrics(doi ='10.1890/ES11-00339.1')
# Or specfiy the doi with the id
# altmetrics('doi/10.1890/ES11-00339.1')
# altmetrics(doi ='10.1038/480426a')
# Or specfiy the doi with the id
# You can do the same for other providers such as pmid, id, and arxiv
# altmetrics('doi/10.1038/480426a')
# ## End(Not run)