Adds an entry to the system configuration of reports to run at given intervals. After generating the configuration from the new entry the function load the current system configuration, adds the new entry and saves the updated system configuration.
createAutoReport(
synopsis,
package,
type = "subscription",
fun,
paramNames,
paramValues,
owner,
ownerName = "",
email,
organization,
runDayOfYear,
startDate = as.character(Sys.Date()),
terminateDate = NULL,
interval = "",
intervalName = "",
dryRun = FALSE
)Nothing unless dryRun is set TRUE in which case a list of all config will be returned
String with description of the report and to be used in subject field of email distributed reports
String with package name also corresponding to registry
Character string defining type of auto report. Currently, one of 'subscription' (default) or 'dispatchment'
String providing name of function to be called for generating report
String vector where each element corresponds to the input parameter to be used in the above function
String vector with corresponding values to paramNames
String providing the owner of the report. Usually a user name
String providing full name of owner. Defaults to an empty string to maintain backwards compatibility
String with email address to recipient of email containing the report
String identifying the organization the owner belongs to
Integer vector with day numbers of the year when the report is to be run
Date-class date when report will be run first time. Default
value is set to Sys.Date() + 1 i.e. tomorrow.
Date-class date after which report is no longer run.
Default value set to NULL in which case the function will provide an
expiry date adding 3 years to the current date if in a PRODUCTION context
and 1 month if not
String defining a time interval as defined in
seq.POSIXt. Default value is an empty string
String providing a human understandable representation of
interval. Default value is an empty string
Logical defining if global auto report config actually is to be updated. If set to TRUE the actual config (all of it) will be returned by the function. FALSE by default
deleteAutoReport