R/remove_test_records.R

In MVR-GIS/rarr: Risk Analysis Report in R

#' @title Remove Test Records
#'
#' @description Removes test records from the input data frame.
#'
#' @export
#'
#' @param df        data frame; The data frame containing test records to
#'                  be removed.
#' @param id_field  character; id field to be checked for removal
#'
#' @return A data frame with the test records removed.
#'
#' @examples
#' # Get test data
#' db_risk <- rarr::db_risk
#'
#' # remove test records
#' risk <- remove_test_records(db_risk, "RISK_NO")
#'
#' @importFrom stringr str_to_lower
#' @importFrom dplyr mutate filter select
#' @importFrom rlang sym .data := !!
#' @importFrom magrittr %>%
#'
remove_test_records <- function(df, id_field) {
  # Check inputs
  if(!is.data.frame(df)) {stop("df must be a data frame")}
  if(!(id_field %in% colnames(df))) {stop("id_field is not a field in df")}

  df <- df %>%
    dplyr::mutate(id := stringr::str_to_lower(!!sym(id_field))) %>%
    mutate(id_test = str_extract(.data$id, "test")) %>%
    filter(!.data$id_test %in% "test") %>%
    select(!c(.data$id, .data$id_test))

  return(df)
}