run_start: Start the framework

In mickmioduszewski/framerrr: Framework that Increases Portability Decreases Maintenance Errors

Description

Sets defaults and starts the framework

Usage

run_start(
  project = "project",
  envir = "default",
  dref = vector(mode = "character", length = 0),
  tz = Sys.timezone(),
  log = "f_log",
  global_config = file.path(dirname(getwd()), "config", "config.R"),
  local_config = file.path(getwd(), "config.R"),
  f_log = list(file = "log.csv", dir = "d_internal"),
  d_output = c(dir = file.path(dirname(dirname(getwd())), "AnalyticSoftwareOutput")),
  d_input = c(dir = file.path(dirname(dirname(getwd())), "AnalyticSoftwareInput")),
  d_internal = c(dir = file.path(dirname(dirname(getwd())),
    "AnalyticSoftwareInternal"))
)

Arguments

project	A character vector of length 1 containing the name of the project.
envir	A name for the environment.
dref	A character vector with the list of configuration entries that contain multiple definitions, each referring to a specific named operating environment.
tz	A time zone to use in date and time calculations.
log	A name of a variable that contains the definition of the log location for the project.
global_config	A definition of the location of the global configuration file. Make it NA if you don't want a global configuration file.
local_config	A definition of the location of the local configuration file. Make it NA if you don't want a global configuration file.
f_log	A definition of the log location for the project.
d_output	A definition of the output directory.
d_input	A definition of the input directory.
d_internal	A definition of the internal directory

Details

This is function has no parameters.

Value

The configuration environment.

Examples

run_start(global_config = NA, local_config = NA)

mickmioduszewski/framerrr documentation built on Oct. 19, 2020, 3:58 a.m.