R/CleanActions_m0.R

In derecost/LOGAN: Log File Analysis in International Large-Scale Assessments

#' @title Clean events
#' @description This function allows you to clean events in the 'event.type'
#'   variable
#'
#' @param data A \code{matrix} or \code{data.frame} where the 'event.type'
#'   variable is
#' @param event.type a vector with concatenate events. See \code{ConcatActions}
#'   function.
#' @param clear.events a vector where all the events to be cleaned are listed.
#'   Each element of this vector needs to be of a \code{"event"=""} type.
#'
#' @return This function returns a \code{data.frame} with the "new.event.type"
#'   variable that cleaned events from the "event.type" variable.
#'
#' @examples
#' # Data preparation
#' df <- cp025q01
#' df$id <- paste(df[, 1], df[, 2], df[, 3], sep = "-")
#' df <- m0$TrimVar(df, c("event", "event_type", "diag_state"))
#' df <- m0$ConcatActions(df, c(rlang::quo(event), rlang::quo(event_type)))
#'
#' # Function demonstration
#' df.clean <- m0$CleanActions(df, event_type, c("ACER_EVENT_" = ""))
#' table(df$event.type)
#' table(df.clean$new.event.type)  # cleaned version
#'
CleanActions <- function(data, event.type, clear.events) {
    event.type <- rlang::enquo(event.type)
    data <- dplyr::mutate(data,
                          new.event.type = stringr::str_replace_all(!!event.type,
                                                                    clear.events))
    return(data)
}