osfr (version 0.1.1)

get_nodes: Retrieve nodes associated with id

Description

This function retrieves the JSON returned by the OSF API for a given OSF id. If the contributors, files, or children arguments are set to TRUE, then the linked JSON for that category is returned. Note that only one of contributors, files, and children can be selected.

Usage

get_nodes(id = NULL, contributors = FALSE, files = FALSE,
  children = FALSE, private = FALSE)

Arguments

id

The id to search for. Use `NULL` to retrieve all, `me` for logged in account. Maximum of 1 id.

contributors

Boolean to extract the contributors of the node

files

Boolean to retrieve files

children

Boolean to retrieve children nodes of id

private

Boolean, retrieve private node

Value

List object of results

Examples

# NOT RUN {
get_nodes()
get_nodes(id = 'me')
get_nodes(id = 'm5pds')
# }