cu-options: Global options for the clickrup package

In psolymos/clickrup: Interacting with the ClickUp v2 API from R

Global options for the clickrup package

Description

Options store and allow to set global values for the ClickUp API and for clickrup functions.

Usage

cu_options(...)

Arguments

...	Options to set.

Details

Options are mostly for internal use and to allow API version changes in the future.

The tz (time zone) option can be set globally for cu_date_from(). The default value "" means current time zone, see strptime().

Value

When parameters are set by cu_options, their former values are returned in an invisible named list. Such a list can be passed as an argument to cu_options to restore the parameter values. Tags are the following:

• baseurl: ClickUp API base URL.

• version: ClickUp API version.

• tz: time zone.

• useragent: user agent.

Examples

str(cu_options())

op <- cu_options(tz = "GMT") # save old values and set tz
cu_options()$tz              # new tz value
cu_options(op)               # reset
cu_options()$tz              # default tz value

psolymos/clickrup documentation built on Feb. 9, 2024, 10:09 a.m.