Function to output configuration settings to report.

Config.Out(
  fun.myConfig = "",
  fun.myDir.export = getwd(),
  fun.myReport.format = "html",
  fun.myReport.Dir = ""
)

Arguments

fun.myConfig

Configuration file to use for this data analysis. The default is always loaded first so only "new" values need to be included. This is the easiest way to control time zones.

fun.myDir.export

Directory for export data. Default is current working directory.

fun.myReport.format

Report format (docx or html). Default = html.

fun.myReport.Dir

Report (rmd) template folder. Default is the package rmd folder. Can be customized in config.R; ContData.env$myReport.Dir.

Value

Creates a report of the user provided configuration file. A copy of the configuration file is also generated with "Config_Out", date, and time as a prefix to the provided configuration file.

Details

When creating a custom config file the newenv() line must be commented out. Otherwise a second environment is created and will not be used during the operation of the functions in this package.

Examples

# default outputs to temp directory
Config.Out(fun.myDir.export = tempdir())
#> [1] TRUE