alm_alerts: Retrieve alerts data for article-level metrics (ALM).

In alm: R Client for the Lagotto Altmetrics Platform

Description

Retrieve alerts data for article-level metrics (ALM).

Usage

alm_alerts(source_id = NULL, publisher_id = NULL, ids = NULL,
  class_name = NULL, level = NULL, q = NULL, unresolved = FALSE,
  per_page = 50, page = 1, user = NULL, pwd = NULL,
  api_url = "http://alm.plos.org/api/v4/alerts", ...)

Arguments

source_id	(character) Source to limtit alert search to.
publisher_id	(character) Metrics for articles by a given publisher, using the Crossref member_id.
ids	(character) Article identifiers
class_name	(character) Which error to get
level	(character) Alert level to limit search to. One of ERROR, WARN, INFO, or FATAL. Default: all.
q	(character) Query terms
unresolved	(logical) Whether to give back unresolved alerts only.
per_page	(integer) Number of records to return. Default: 50. Max: ?
page	(integer) Number from 1 to number of pages
user	(character) Username
pwd	(character) Password
api_url	URL to use.
...	Further args passed to httr::GET

Details

This function uses the alm.plos.org API by default. You can change which ALM app you use by specifying the url in the api_url parameter. It will likely be the same as the default http://alm.plos.org/api/v4/alerts, but just the alm.plos.org part will be different.

ALM installations on the most current version (3.4.7) can be used in this function, as of 2014-08-26 those are PLOS, ALM Labs, and Crossref Labs.

Examples

## Not run: 
alm_alerts()
alm_alerts(q='mismatch')
alm_alerts(unresolved=TRUE)
alm_alerts(class_name='NoMethodError')
alm_alerts(class_name='ApiResponseTooSlowError')
alm_alerts(level='Error')
alm_alerts(ids="10.1371/journal.pone.0029797")

# curl debugging
library("httr")
alm_alerts(level='Error', config=verbose())

# paging
alm_alerts(per_page=2)

# by source_id
alm_alerts(source_id = "wos")

# by publisher_id
alm_alerts(publisher_id = 340)

## End(Not run)

alm documentation built on Jan. 15, 2017, 3:22 p.m.