public_groups_overview: public_groups_overview.R Public Group Methods (Public...

View source: R/public_groups_overview.R

public_groups_overviewR Documentation

public_groups_overview.R Public Group Methods (Public Methods)

Description

This method will return a list of public groups available on Mendeley sorted by number of members.

Usage

public_groups_overview(page = NA, numItems = 1000L, cat = NA,
  key = getOption("MendeleyKey", stop("need an API key for Mendeley")),
  url = "http://api.mendeley.com/oapi/documents/groups",
  curl = getCurlHandle(), ...)

Arguments

page

number pages to return (optional)

numItems

number of hits to return (optional)

cat

Only tags appearing in this subject category See the search-categories function to obtain a list of the numeric codes corresponding to each of the main subject categories.

key

Mendeley API key (otherwise will try and load from package)

url

the Mendeley API url for the function (should be left to default)

...

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

detailed metadata for all articles in the public group

Examples

## Not run: 
 public_groups_overview()

## End(Not run)

ropensci/RMendeley documentation built on May 18, 2022, 8:58 a.m.