R/df-tests.R

In joshmuncke/easytest: Make Testing Great Again!

#' Test that there are no duplicates in a dataframe
#'
#' Performs a test that a dataframe has no duplicate rows.
#' Column names can be passed in (like \code{\link[dplyr]{select}})
#' if you wish to restrict the duplicate search to just these columns.
#'
#' @param df A dataframe
#' @param ... Optional selection of specific columns to include in the
#' duplicate check.
#'
#' @return The dataframe passed to the function.
#'
#' @details
#' When selecting a subset of columns be aware that duplicates will
#' still be looked for within the entire row - not for each column
#' individually.
#'
#' @examples
#' # Basic usage - passes
#' test_no_duplicates(mtcars)
#'
#' # Select specific columns - fails
#' \dontrun{
#' test_no_duplicates(mtcars, cyl)
#' }
#'
#' # Can also be used in magrittr pipe
#' library(dplyr)
#' mtcars %>% test_no_duplicates() %>% select(mpg)
#'
#' @export
test_no_duplicates <- function(df, ...) {
  df_name <- deparse(substitute(df))
  col_names <- rlang::quos(...)

  if(length(col_names) == 0) {
    df_select <- df %>% tibble::rownames_to_column()
    test_message <- glue::glue("No duplicate values in dataframe [{df_name}]", df_name = df_name)
  }

  else {
    df_select <- df %>% tibble::rownames_to_column() %>% dplyr::select(!!! col_names)
    test_message <- glue::glue("No duplicate values in columns [{col_names}] of dataframe [{df_name}]", col_names = col_names, df_name = df_name)
  }

  distinct_df_select <- df_select %>% dplyr::distinct()

  testthat::test_that(test_message,
                      testthat::expect_identical(df_select, distinct_df_select))

  invisible(df)
}

#' Test that there are no missing values in a dataframe
#'
#' Performs a test that a dataframe has no duplicate rows.
#' Column names can be passed in (like \code{\link[dplyr]{select}})
#' if you wish to restrict the duplicate search to just these columns.
#'
#' @param df A dataframe
#' @param ... Optional selection of specific columns to include in the
#' duplicate check.
#'
#' @return The dataframe passed to the function.
#'
#' @details
#' When selecting a subset of columns be aware that duplicates will
#' still be looked for within the entire row - not for each column
#' individually.
#'
#' @examples
#' # Basic usage - passes
#' test_no_duplicates(mtcars)
#'
#' # Select specific columns - fails
#' \dontrun{
#' test_no_duplicates(mtcars, cyl)
#' }
#'
#' # Can also be used in magrittr pipe
#' library(dplyr)
#' mtcars %>% test_no_duplicates() %>% select(mpg)
#'
#' @export
test_complete <- function(df, ...) {
  df_name <- deparse(substitute(df))
  col_names <- rlang::quos(...)

  if(length(col_names) == 0) {
    df_select <- df %>% tibble::rownames_to_column()
    test_message <- glue::glue("No missing values in dataframe [{df_name}]", df_name = df_name)
  }

  else {
    df_select <- df %>% tibble::rownames_to_column() %>% dplyr::select(!!! col_names)
    test_message <- glue::glue("No missing values in columns [{col_names}] of dataframe [{df_name}]", col_names = col_names, df_name = df_name)
  }

  complete_df_select <- df_select %>% dplyr::filter(stats::complete.cases(.))

  testthat::test_that(test_message,
                      testthat::expect_identical(df_select, complete_df_select))

  invisible(df)
}

#' Test the number rows in a dataframe
#'
#' Performs a test that the dataframe has the number of rows you expect.
#'
#' @param df A dataframe
#' @param n Expected number of rows
#'
#' @return The dataframe passed to the function.
#'
#' @examples
#' # Basic usage
#' test_n_rows(mtcars, 32)
#'
#' # Can also be used in magrittr pipe
#' library(dplyr)
#' mtcars %>% test_n_rows(32) %>% select(mpg)
#'
#' @export
test_n_rows <- function(df, n) {
  df_name <- deparse(substitute(df))
  df2_name <- deparse(substitute(df2))

  df_rows <- nrow(df)

  test_message <- glue::glue("Number of rows in dataframe [{df_name}] is == ({n})", df_name = df_name, n = n)

  testthat::test_that(test_message,
                      testthat::expect_equal(df_rows, n))

  invisible(df)
}

#' Test that two dataframes are equal
#'
#' Performs a test that the dataframe is equal to another dataframe.
#'
#' @param df A dataframe
#' @param df2 Another dataframe
#'
#' @return df
#'
#' @examples
#' # Basic usage
#' \dontrun{
#' test_same_as_other_df(mtcars, mtcars)
#' test_same_as_other_df(mtcars, iris)
#' }
#'
#' # Can also be used in magrittr pipe
#' \dontrun{
#' library(dplyr)
#' mtcars %>%
#' mutate(mpg = 50) %>%
#' test_same_as_other_df(mtcars)
#' }
#'
#' @export
test_same_as_other_df <- function(df, df2) {
  df_name <- deparse(substitute(df))
  df2_name <- deparse(substitute(df2))

  test_message <- glue::glue("Dataframe [{df_name}] is equal to dataframe [{df2_name}]", df_name = df_name, df2_name = df2_name)

  testthat::test_that(test_message,
                      testthat::expect_equal(df, df2))

  invisible(df)
}

#' Test that two dataframes have the same number of rows
#'
#' Performs a test that the dataframe has the number of rows as
#' another dataframe (even if the contents are different).
#'
#' @param df A dataframe
#' @param df2 Another dataframe
#'
#' @return df
#'
#' @examples
#' # Basic usage
#' \dontrun{
#' test_equal_rows(mtcars, mtcars)
#' test_equal_rows(mtcars, iris)
#' }
#'
#' # Can also be used in magrittr pipe
#' library(dplyr)
#' mtcars %>%
#' mutate(mpg = 50) %>%
#' test_equal_rows(mtcars)
#'
#' @export
test_equal_rows <- function(df, df2) {
  df_name <- deparse(substitute(df))
  df2_name <- deparse(substitute(df2))

  df_rows <- nrow(df)
  df2_rows <- nrow(df2)

  test_message <- glue::glue("Dataframe [{df_name}] has the same number of rows as dataframe [{df2_name}]", df_name = df_name, df2_name = df2_name)

  testthat::test_that(test_message,
                      testthat::expect_equal(df_rows, df2_rows))

  invisible(df)
}