uniset_autoUpS {uniset} | R Documentation |
Automatically update Settings
Description
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:
|
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 |
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
.
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.
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
{
## Not run:
# to be called from within the target package
uniset_autoUpS(uniset_handover, "dogPack_demo_setup")
## End(Not run)
}