alm (version 0.4.0)

alm_signposts: Retrieve PLOS article-level metrics signposts.

Description

This includes:

• viewed: counter, and pmc (PLOS only)
• saved: mendeley, and citeulike
• discussed: facebook, and twitter at PLOS
• cited: crossref, and scopus at PLOS

Usage

alm_signposts(doi = NULL, pmid = NULL, pmcid = NULL, wos = NULL, scp = NULL, url = NULL, source_id = NULL, key = NULL, api_url = "http://alm.plos.org/api/v5/articles", ...)

Arguments

doi

Digital object identifier for an article in PLoS Journals (character)

pmid

PubMed object identifier (numeric)

pmcid

PubMed Central object identifier (numeric)

wos

Web of Science identifier (character)

scp

Scopus identifier (character)

url

Canonical URL (character)

source_id

(character) Name of source to get ALM information for. One source only. You can get multiple sources via a for loop or lapply-type call.

key

your PLoS API key, either enter, or loads from .Rprofile (character)

api_url

API endpoint, defaults to http://alm.plos.org/api/v3/articles (character)

...

optional additional curl options (debugging tools mostly)

Value

A data.frame of the signpost numbers for the searched object, and DOIs.

Details

This is just a wrapper around the function alm_ids, forcing info="summary", then coercing signposts data to a data.frame.

References

See a tutorial/vignette for alm at http://ropensci.org/tutorials/alm_tutorial.html

See Also

alm_ids, plot_signposts

Examples

## Not run: 
# # The default call with either doi, pmid, pmcid, wos, scp, or url without specifying
# # an argument for info
# alm_signposts(doi="10.1371/journal.pone.0029797")
# 
# # Many DOIs
# dois <- c('10.1371/journal.pone.0001543','10.1371/journal.pone.0040117',
# '10.1371/journal.pone.0029797','10.1371/journal.pone.0039395')
# alm_signposts(doi=dois)
# 
# # A single PubMed ID (pmid)
# alm_signposts(pmid=22590526)
# 
# # A single PubMed Central ID (pmcid)
# alm_signposts(pmcid=212692)
# 
# # A single PubMed Central ID (pmcid)
# alm_signposts(source_id = "crossref")
# 
# # Curl debugging
# library('httr')
# alm_signposts(pmid=22590526, config=verbose())
# ## End(Not run)