alm (version 0.1.9)

signposts: Retrieve PLOS article-level metrics signposts.

Description

This includes:

• views: counter + pmc (PLOS only)
• shares: facebook (+ twitter at PLOS)
• bookmarks: mendeley + citeulike
• citations: crossref (scopus at PLOS)

Usage

signposts(doi = NULL, pmid = NULL, pmcid = NULL, mdid = NULL,
  url = "http://alm.plos.org/api/v3/articles", months = NULL, days = NULL,
  year = NULL, source = NULL, key = NULL, curl = getCurlHandle())

Arguments

doi

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

pmid

PubMed object identifier (numeric)

pmcid

PubMed Central object identifier (numeric)

mdid

Mendeley object identifier (character)

url

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

months

Number of months since publication to request historical data for. See details for a note. (numeric)

days

Number of days since publication to request historical data for. See details for a note. (numeric)

year

End of which year to request historical data for. See details for a note. (numeric)

source

Name of source (or list of sources) to get ALM information for (character)

key

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

...

optional additional curl options (debugging tools mostly)

curl

If using in a loop, call getCurlHandle() first and pass the returned value in here (avoids unnecessary footprint)

Value

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

Details

This is just a wrapper around the function alm, 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, plot_signposts

Examples

# The default call with either doi, pmid, pmcid, or mdid without specifying
# an argument for info
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')
signposts(doi=dois)

# A single PubMed ID (pmid)
signposts(pmid=22590526)

# A single PubMed Central ID (pmcid)
signposts(pmcid=212692)

# A single Mendeley UUID (mdid)
signposts(mdid="35791700-6d00-11df-a2b2-0026b95e3eb7")