R/factor-ref-level.R

In mattwarkentin/sandbox: Miscellaneous Functions

#' @title Declare and Recover Factor Reference Level
#'
#' @description Text goes here...
#'
#' @param data Data frame.
#' @param .sep Delimeter.
#' @param ... Factor variables to declare.
#' @param .null Null effect size.
#'
#' @details Text here...
#'
#' @name fct_declare
#'
#' @return The input data is returned with attributes attached.

fct_declare <- function(data, ..., .sep = "") {
  assertthat::assert_that(any(class(data) %in% c('tbl', 'data.frame')))

  vars <- tidyselect::vars_select(names(data), ...)

  data <- data %>%
    dplyr::select({{ vars }}) %>%
    dplyr::mutate_all(forcats::as_factor)

  create_fcts <- function(level, sep = .sep){
    name <- names(level)
    level <- purrr::chuck(level, 1)

    lev_name <- tibble(
      term = glue::glue('{name}{level}')
    )
    lev_name
  }

  levels <- purrr::map(data, ~levels(.))
  tib <- purrr::map(levels, ~create_fcts(., sep = .sep))
  tib
}

#' @export
#' @rdname fct_declare
fct_recover <- function(data, .null = NULL){
  assertthat::assert_that(!is.null(.null),
                          msg = "You must specify the null effect!")
}