R/log_unused_variables.R

Defines functions log_unused_variables

log_unused_variables <- function(data,
                                 chapter_structure,
                                 auxiliary_variables = NULL,
                                 log_file = NULL) {
  used_vars <-
    unique(c(
      as.character(chapter_structure$.variable_name_dep),
      as.character(chapter_structure$.variable_name_indep),
      auxiliary_variables
    ))
  not_used_vars <- colnames(data)[!colnames(data) %in% used_vars]
  if (length(not_used_vars) > 0) {
    cli::cli_inform("Not using the following variables in {.arg data}: {.var {cli::ansi_collapse(not_used_vars, trunc = 100)}}.")
    if (is_string(log_file)) {
      cat("\nNot using the following variables:\n", file = log_file, append = TRUE)
      cat(not_used_vars, sep = "; ", file = log_file, append = TRUE)
    }
  }
}

Try the saros.base package in your browser

Any scripts or data that you put into this service are public.

saros.base documentation built on June 8, 2025, 10:03 a.m.