intrOptions: Gets or sets Intrinio package options

In ksavin/intrinio: API wrapper for intrinio.com financial data feeds.

Description

To avoid passing frequent options to every API wrapper, they are defined globally (within package scope).

Usage

intrOptions(...)

Arguments

...	Named arguments for option setting. Will return all current options if none are specified.

Details

Currenly the following options are available:

verbose:

Will show status messages if set to TRUE.
Default: TRUE

costWarning:

If TRUE, will ask for user confirmation in case when request costs more than warnThreshold API call credits (useful for multipage calls).
Default: FALSE

warnThreshold:

Minimum number of API calls in multipage request to request confirmation.
Default: 50

outFormat:

Format of resulting output.
Possible options: 'data.frame' or 'data.table'.
Default: 'data.frame'

maxPageSize (view only):

A data.frame with maximum page size by endpoint. Used to determine default page size in intrMultipage call. To override, pass page_size to API call when needed. See Paging Limits

Value

A list of options if none are passed

Note

Options are reset to default on every package reload.

Examples

# get option list
intrOptions()

# modify options
intrOptions(verbose = TRUE, costWarning = FALSE)

ksavin/intrinio documentation built on May 20, 2019, 7:03 p.m.