alm (version 0.4.0)

alm_sources: Retrieve PLoS article-level metrics (ALM) by source.

Description

See details for more information.

Usage

alm_sources(source_id = "crossref", info = "totals", key = NULL, total_details = FALSE, sum_metrics = NULL, limit = 50, page = 1, url = "http://alm.plos.org/api/v5/articles", ...)

Arguments

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.

info

One of totals, summary, or detail (default totals + sum_metrics data in a list). Not specifying anything (the default) returns data.frame of totals across data providers. (character)

key

(character) Your API key, either enter, or loads from .Rprofile. Only required for PKP source, not the others.

total_details

If FALSE (the default) the standard totals data.frame is returned; if TRUE, the totals data is in a wide format with more details about the paper, including publication date, title, etc. If you set this to TRUE, the output should no longer with with alm_plot.

sum_metrics

Just like the output you get from setting info='totals', you can get summary metrics by day (sum_metrics='day'), month (sum_metrics='month'), or year (sum_metrics='year').

limit

(integer) Number from 1 to infinity. This doubles as the rows parameter, which is what's called internally to the API service. The max results per page is 50, so if you use a value > 50, then we essentially loop through to get all the results you want.

page

(integer) Number from 1 to infinity.

url

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

...

optional additional curl options (debugging tools mostly)

References

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

Examples

## Not run: 
# alm_sources()
# alm_sources(source_id='mendeley')
# alm_sources(source_id='scopus', info='summary')
# lapply(c('mendeley','twitter'), alm_sources, limit = 2)
# alm_sources(source_id='mendeley', limit=2)
# alm_sources(source_id='mendeley', limit=2, page=2)
# alm_sources(source_id='mendeley', limit=200)
# 
# alm_sources(source_id='mendeley', info='summary')
# ## End(Not run)