phase_date_data: minimal tidy data set for regregrap report production.

In mammykins/regregrap:

Description

year_phase_data is the class used for the creation of all figures and tables in the made up RAP report (it's a demo for the RAP MOOC).

Usage

phase_date_data(x, log_level = futile.logger::WARN,
  log_appender = "console", eda = FALSE)

Arguments

x	Input dataframe, see details.
log_level	The severity level at which log messages are written from least to most serious: TRACE, DEBUG, INFO, WARN, ERROR, FATAL. Default is level is INFO. See ?flog.threshold() for additional details.
log_appender	Defaults to write the log to "console", alternatively you can provide a character string to specify a filename to also write to. See for additional details ?futile.logger::appender.tee().
eda	If TRUE an graphical data analysis is conducted for a human to check.

Details

The year_phase_data class expects a data.frame with at least three columns: phase, date (entry-timestamp), and register name. Each row represents a unique register.

Once inititated, the class has five slots: df: the basic data.frame, colnames: a character vector containing the column names from the df, phase_levels: a factor vector containing levels of df$phase of the factor sector, yq: an date vector containing zoo::as.yearqrt(df$date).

Value

If the class is not instantiated correctly, nothing is returned.

Examples

library(regregrap)

df <- phase_date_data(regreg)

mammykins/regregrap documentation built on May 16, 2019, 9:14 p.m.