This set of functions are used to configure the settings used to interact with the mongoDB database.
toxbootConf(mongo_host = NULL, collection = NULL, user = NULL,
pass = NULL, db = NULL, port = NULL)toxbootConfSave()
toxbootConfReset()
toxbootConfLoad()
toxbootConfList(show.pass = FALSE)
Character of length 1, database IP address
Character of length 1, the collection on the database to read from and write to
Character of length 1, username to authenticate
Character of length 1, password that corresponds to username
Character of length 1, database where the username and pass are authenicated. Can be an IP address or a url.
Character of length 1, the port on mongo_host to connect to MongoDB. Typically this is 27017.
Logical, should the password be returned
Parameter settings are stored in two places. Long term storage on
disk is in a configuration file, toxboot.config, located in the toxboot
package directory within the library. This allows default settings to be
maintained between sessions without a need for including IP addresses and
login credentials within user scripts. During runtime, parameter settings
are set in options to be used by various toxboot functions.
The toxboot configuration functions are used to read and/or write
parameters from/to the toxboot.config configuration files at the settings
in options.
toxbootConf changes options to set the toxboot options used
to interact with mongoDB when reading or writing results. This includes the
location of the database, which collection to use, and a username and
password to authenticate against the database. toxbootConf will only
change non-null values, and can be used to change a single value if needed.
toxbootConfSave modifies the toxboot.config file. Current global
parameters are ready from options using toxbootConfList and
the values are stored in toxboot.config within the toxboot directory within
the library.
toxbootConfList returns the toxboot global parameters from
options.
toxbootConfLoad reads the toxboot parameters from toxboot.config and
updates options with these settings.
toxbootConfReset will overwrite toxboot.config setting all
parameters to NA. This is used to remove any user information from the
file.