R/prep_df.R

In zsmith27/toolbox: Commonly Used Functions For Data Preprocessing

#' @title Prepare Data Frame
#' @description FUNCTION_DESCRIPTION
#' @param x PARAM_DESCRIPTION
#' @param standard.names Should column names be standardized?, Default: TRUE
#' @param standard.char Should character column strings be standardized?, Default: TRUE
#' @param drop.na.cols Should columns containing only NAs be dropped?, Default: FALSE
#' @inheritParams standard_names
#' @return A standardized data frame.
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  data("starwars")
#'  test.df <- head(starwars)
#'  prep_df(test.df)
#'  prep_df(test.df, replacement.char = "+")
#'  }
#' }
#' @rdname prep_df
#' @export 

prep_df <- function(x, standard.names = TRUE, standard.char = TRUE, drop.na.cols = FALSE, ...){
  if (!is.data.frame(x)) stop("'x' must be a data frame or tibble")
  final.df <- x
  if (standard.names == TRUE) final.df <- standard_names(final.df, ...)
  if (standard.char == TRUE) final.df <- standard_char(final.df, ...)
  if (drop.na.cols == TRUE) final.df <- dplyr::filter(final.df, !rowSums(is.na(.)) == ncol(.))
  # final.df[final.df == ""] <- NA
  return(final.df)
}