compliance_data: Create minimal tidy data set for caculating compliance cost

Description Usage Arguments Details Value

View source: R/Import Data Function.R

Description

compliance_data is the class used for preforming the analysis

Usage

1
2
compliance_data(x, log_level = futile.logger::WARN,
  log_appender = "console", plot = FALSE)

Arguments

x

The input data frame, see details.

log_level

The severity level at which log messages are written from least to most serious: TRACE, DEBUG, INFO, ERROR, FATAL. Default level is info. See ?flog.threshold() for additional details.

log_appender

Defaults to writing the log to "console", or can procide a character string to specify a filename to write to. For additional details ?futile.logger::appender.tee()

plot

If True a plot is drawn for visual inspection.

Details

The function reads in a dataframe containg the compliance review and converts to a custom class compliance_data. This quality checks the data and creates the minimal tidy data set needed for caculating the compliance cost.

The compliance review contains 4 varibles but spread over mutiple columns in a messy excel sheet. This function checks and tidyies.

Value

Return compliance_data class object if instantiated correctly, otherwise nothing.


loudsneeze/election documentation built on May 30, 2019, 12:43 p.m.