get_functions: Connection and data download functions

In opendatabio/opendatabio-r: Imports and Exports Data From an OpenDataBio Server

Description

These are some basic functions to interact with the API and download data. See the full help on the package vignettes.

Usage

odb_test(odb_cfg = odb_config())

odb_get_bibreferences(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_datasets(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_biocollections(
  params = list(),
  odb_cfg = odb_config(),
  simplify = TRUE
)

odb_get_individuals(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_occurrences(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_languages(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_locations(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_measurements(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_persons(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_projects(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_taxons(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_traits(params = list(), odb_cfg = odb_config(), simplify = TRUE)

odb_get_vouchers(params = list(), odb_cfg = odb_config(), simplify = TRUE)

Arguments

odb_cfg	list. A configuration object, as generated by odb_config
params	named list, named vector or character string. Represents the parameters to be sent for the server, such as "valid=1" to return only valid taxons. See odb_params
simplify	logical. Should the results be 'unlisted' before being returned?

Value

odb_get methods usually return a data.frame is simplify=TRUE, but that depends on the JSON response received from the server.

Examples

## Not run: 
cfg = odb_config()
# Test request
odb_test()
# Gets some taxons
param = list(level=210, valid=TRUE, limit=5)
taxons = odb_get_taxons(param, cfg)
print(taxons)

## End(Not run)

opendatabio/opendatabio-r documentation built on Sept. 27, 2021, 1:32 a.m.