inst/examples/dogPack/R/dogPackFunc.r

In uniset: Dynamic Settings File

#' @title Test Target Package Parameters
#' @description Simple test if setup is ok.
#' @return  Prints target package name, environment name, name of list-object,
#' name of folder where the local 'dogPack_settings.R' resides etc, 
#' and gives it back as (invisible) list.
#' @export
dogPack_test_targetPackageParams <- function() {
	#
    out <- uniset::uniset_test(get("uniset_handover"))
    # this line, called from a function in the target package, in our example
    # the package 'dogPack',is only intended to test if the handover of values
    # via the customised handover function is working correctly.
    return(invisible(out))
} # EOF




#' @title Perform Setup
#' @description Set up the local system for the use of the dynamic
#' settings file.
#' @param where Character length one. Holding the path to the folder where the
#' local settings.R file should be stored.
#' @return No return value, demo function called for its side effects, i.e. to
#' perform the setup.
#' @export
dogPack_demo_setup <- function(where=NULL) {
	#
    uniset::uniset_setup(where, get("uniset_handover"))
    # provide a function like this, with the one line above in it, to the user of
    # the target package. This function 'uniset_setup' only has to be called once.
    # In the target package, instruct / inform the user to call a function of
    # the target package (like this one) in order to setup the local system to
    # make use the dynamic settings file.
    return(invisible(NULL))
} # EOF




#' @title Demo Update Settings
#' @description Manually update the settings.
#' @param silent Logical. If a confirmation should be printed. Defaults to
#' 'FALSE'.
#' @return A (invisible) list containing the key=value pairs from the settings
#' file.
#' @export
dogPack_demo_updateSettings <- function(silent=FALSE) {
	#
    stn <- updateSettings(silent)
    # customized function defined in !dogPack!
    #
    # use this line in a function defined in the target package, in our example
    # the package 'dogPack', to manually read in and update the values from the
    # settings file.
    # A possible use could be to have a direct way to check if updating the
    # values from the settings file works correctly.
    return(invisible(stn))
} # EOF




#' @title Demo Autoupdate
#' @description Automatically update the settings. Is also reading the value of
#' the key 'favouriteColor' from the 'dogPack_settings.R' file.
#' @param txt Character
#' @param tellMe Logical. If the favourite color should be printed.
#' @return Is called for its side effects, i.e. to automatically update
#' resp. (re-)source the settings file. If 'tellMe' is left at the default
#' 'TRUE', the value of the key 'favouriteColor' in the settings file is
#' printed. Returns (invisible) NULL.
#' @export
dogPack_demo_autoUpS <- function(txt="My favourite color is ", tellMe=TRUE) {
	#
    stn <- autoUpS()
    # customized function defined in !dogPack!
    #
    # As the developer of the target package, in our example the package
    # 'dogPack', you would include this line (the package name is of course not
    # necessary) at the top of each and every single function that you want to
    # trigger the auto-update mechanism, i.e. when the key=value pairs from
    # the local 'dogPack_settings.R' file should be updated and read in.
    
    # Function 'dogPack::autoUpS' is containing the function
    # 'uniset::uniset_autoUpS()', what is the one function that confers the
    # main functionality of package 'uniset'.

    # By calling 'dogPack::autoUpS()', the local key=value pairs from the
    # settings file get updated according to the template from the
    # target package, and the object ('settings' in our example) containing the
    # list with the key=value pairs is updated/sourced.

    #  Here would be the main body of the function.
    # ...
    # ...
    # ...


    # Any key=value pairs of the settings file can be accessed in the body of a function defined
    # in the target package, in our example this package 'dogPack', as shown below:

    # favColor <- .dogPack_settingsEnv$settings$favouriteColor # it works, but would throw a note when running CMD-CHECK
    favColor <- stn$favouriteColor # we defined 'stn' above

    txtOut <- paste0(trimws(txt), ": ", favColor, "\n")
    if (tellMe) {
        cat(txtOut)
    } # end if
    return(invisible(NULL))
} # EOF




#' @title Demo No Autoupdate
#' @description A function that is \strong{not} auto-updating the values from
#' the settings file. Is also reading the value of the key 'favouriteColor'
#' from the 'dogPack_settings.R' file.
#' @param tellMe Logical. If the favourite color should be printed.
#' @param txt Character
#' @return Does NOT update resp. (re-)sourece the settings file. If 'tellMe' is
#' left at the default 'TRUE', the value of the key 'favouriteColor' in the settings
#' file is printed. Returns (invisible) NULL.
#' @export
dogPack_demo_No_autoUpS <- function(txt="My favourite color is ", tellMe=TRUE) {

	stn <- getstn()
	# customized function defined in !dogPack!
	#
    # 'getstn()' is a function defined in the package dogPack, but has been
    # customized by package 'uniset' at the time of generating the three
    # required files.

    #  Here would be the main body of the function.
    # ...
    # ...
    # ...

    # Any key=value pairs of the settings file can be accessed in the body of a function defined
    # in the target package, in our example this package 'dogPack', as shown below:
    favColor <- stn$favouriteColor # we defined 'stn' above

    txtOut <- paste0(trimws(txt), ": ", favColor, "\n")
    if (tellMe) {
        cat(txtOut)
    } # end if
    return(invisible(NULL))
} # EOF




#' @title Tell favourite Color
#' @description Tells the favourite color as defined in the settings.R file.
#' @return Character length one, the favourite color as defined in the
#' settings.R file.
#' @export
dogPack_demo_tellFavouriteColor <- function() {
    stn <- getstn()
    favColor <- stn$favouriteColor
    return(favColor)
} # EOF