public_groups_documents: public_groups_documents.R Public Group Methods (Public...

In ropensci/RMendeley: Interface to Mendeley API methods

public_groups_documents.R Public Group Methods (Public Methods)

Description

Returns list of documents ids within a public group. It is possible

Usage

public_groups_documents(query, details = FALSE, page = NA,
  numItems = 1000L, key = getOption("MendeleyKey",
  stop("need an API key for Mendeley")), url = sprintf("%s/%s/%s",
  "http://api.mendeley.com/oapi/documents/groups", query, "docs/?details=true"),
  curl = getCurlHandle(), ...)

Arguments

query	a public group ID number
details	if detailed information (public_group_details) should be returned; logical, default is FALSE
page	number pages to return (optional)
numItems	number of hits to return (optional)
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)

Details

to retrieve documents details in the same request setting the optional parameter details to true.

Value

detailed metadata for all articles in the public group

Examples

## Not run: 
public_groups_details(492511)

## End(Not run)

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