Skip to contents

Automatically update Settings

Source: R/gen_functions.R
uniset_autoUpS.Rd

Use this function within your code to automatically update the settings from the users settings file

Usage

uniset_autoUpS(uniset_handover, setupFunc = NULL)

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.

Value

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

Details

If 'autoUpdateSettings' in the local settings.R file is left at 'TRUE', the settings will be checked resp. updated automatically every time a function in the target package is calling uniset_autoUpS.

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_autoUpS(uniset_handover, "dogPack_demo_setup")
}
}