GET_db_contents: Queries the Databrary API with an HTML GET command

View source: R/GET_db_contents.R

GET_db_contentsR Documentation

Queries the Databrary API with an HTML GET command

Description

GET_db_contents is a helper function that retrieves information from the 'Databrary.org' API in a structured way.

[Deprecated]

This function has been deprecated and may be removed in a future version.

Usage

GET_db_contents(
  base_URL = "https://nyu.databrary.org",
  URL_components = "/api/volume/1",
  convert_JSON = TRUE,
  vb = FALSE
)

Arguments

base_URL

Base URL for API call. Default is https://nyu.databrary.org.

URL_components

Other components of API URL usually assembled using a paste0() command.

convert_JSON

A Boolean value. If TRUE, convert JSON to a data frame. Default is TRUE.

vb

A Boolean value. If TRUE provides verbose output.

Value

Output from GET command with the specified parameters, usually a string or a data frame.

Examples


GET_db_contents() # Returns a list with data from volume 1.



PLAY-behaviorome/databraryapi documentation built on April 24, 2024, 4:20 a.m.