api_cli: api_cli

In namc-utah/NAMCr: NAMC Database Access API

api_cli

Description

R6 class for handling NAMC cli driven api calls

Value

a api_cli class (R6 class)

Methods

Public methods

• api_cli$start()

• api_cli$clone()

---

Method start()

Usage

api_cli$start(
  api_endpoint = NA,
  args = list(),
  include = c(),
  exclude = c(),
  filter = list(),
  sort = c(),
  limit = NA,
  api = NULL,
  ...
)

Arguments

api_endpoint

String name of endpoint

args

List of named arguments to pass to the endpoint

include

List of fields to include

exclude

List of fields to exclude

filter

List of fieldname / filter combinations

sort

Array of fields to sort by

limit

Number of results to limit the return by

api

NAMC api instance

...

Returns

nothing is returned

---

Method clone()

The objects of this class are cloneable with this method.

Usage

api_cli$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

auth_config = list(...) # api_cli public or private variables
auth = api_cli$new(api,args)

Starts an api cli instance

namc-utah/NAMCr documentation built on Feb. 12, 2024, 4:29 a.m.