gconfig: configure geoknife settings

View source: R/00-gconfig.R

gconfigR Documentation

configure geoknife settings

Description

access and set defaults for geoknife configuration

Usage

gconfig(..., no.readonly = FALSE)

Arguments

...

values for gconfig

no.readonly

currently not implemented for TRUE

Value

Borrowed text and functionality from par. When parameters are set, their previous values are returned in an invisible named list. Such a list can be passed as an argument to par to restore the parameter values. Use gconfig(no.readonly = TRUE) for the full list of parameters that can be restored. When just one parameter is queried, the value of that parameter is returned as (atomic) vector. When two or more parameters are queried, their values are returned in a list, with the list names giving the parameters. Note the inconsistency: setting one parameter returns a list, but querying one parameter returns a vector.

Examples

gconfig # all config
gconfig('wait')
gconfig('sleep.time' = 10)
gconfig('sleep.time' = 8, wait=TRUE)
gconfig('progress' = FALSE)

USGS-R/geoknife documentation built on April 17, 2023, 8:26 p.m.