bambooHR (version 0.1.1)

use_config: Use Config File

Description

Choose a specific configuration file to supply the API key and the company domain.

Usage

use_config(config = "~/.bambooHR_user_config.json", verbose = TRUE)

Value

[NULL] invisibly.

Arguments

config

Filepath to the config file.

verbose

Print location of config file being used, default = TRUE

Details

In rare circumstances, it may be useful to swap between multiple configuration files, for example when comparing results on different accounts possibly with different permissions. In this case a user may set-up two config files with [config_setup] in different locations (see [conffile] argument), and swap between them with [use_config]. The chosen config file will then be used for subsequent API calls, as [use_config] sets global options and variables in the package environment. Of course, [config_setup] does all of this too, however [use_config] does not expose the API key when called.

Examples

if (FALSE) {
# Setup 2 configuration files
config_setup(apikey = "key", companyname = "Ascent", conffile = "example.json")
config_setup(apikey = "key2", companyname = "Descent", conffile = "example2.json")

# Jump between them
use_config("example.json")
use_config("example2.json")

# Remove them when finished
unlink("example.json")
unlink("example2.json")
}