Skip to contents

Update Settings of Target Package

Source: R/gen_functions.R
uniset_updateSettings.Rd

Manually read in the settings-file in the target package settings home directory as specified in the .Renviron file.

Usage

uniset_updateSettings(uniset_handover, setupFunc = NULL, silent = FALSE)

Arguments

uniset_handover

List length two, containing two elements:

  1. pkgname: The name of the target package.

  2. funcname: The name of the function in the target package handing over the required values. See examples at uniset.

setupFunc

Character length one. The name of the function in the target package performing the setup, i.e. the name of the function that is containing the uniset function uniset_setup. Defaults to 'NULL'; has to be changed.

silent

Logical. If a confirmation should be printed. Defaults to 'FALSE'

Value

This function is called for its side effects, i.e to manually update / (re-)source the settings file. Returns (invisible) 'FALSE' if the update was unsuccessful, otherwise an (invisible) list with the settings sourced from the settings.R file.

Important

This function is meant to be called from within the target package.

Note

Please refer to uniset for a link to examples and a real-world demo.

Examples

{
if (FALSE) {
# to be called from within the target package
uniset_updateSettings(uniset_handover, "dogPack_demo_setup")
}
}