epiCleanr (version 0.2.0)

create_test: Create Test Function

Description

This function creates a test function to perform various data validation checks. The returned function can be applied to a dataset to perform the specified tests.

Usage

create_test(
  dimension_test = NULL,
  combinations_test = NULL,
  row_duplicates = FALSE,
  col_duplicates = FALSE,
  min_threshold_test = NULL,
  max_threshold_test = NULL
)

Value

A function to be applied to the dataset.

Arguments

dimension_test

A vector of two integers specifying the expected number of rows and columns.

combinations_test

A list with the elements `variables` (character vector of variable names) and `expectation` (integer specifying the expected number of unique combinations for each column).

row_duplicates

Logical. If TRUE, checks for duplicate rows.

col_duplicates

Logical. If TRUE, checks for duplicate columns.

min_threshold_test

Named list of minimum threshold values for specified columns.

max_threshold_test

Named list of maximum threshold values for specified columns.

Examples

# get path
path <- system.file(
        "extdata",
        "fake_epi_df_togo.rds",
         package = "epiCleanr")

fake_epi_df_togo <- import(path)

# Set up unit-test function
my_tests <- create_test(
  # For checking the dimension of the data
  dimension_test = c(900, 9),
  # For expected number of combinations in data
 combinations_test = list(
   variables = c("month", "year", "district"),
   expectation = 12 * 5 * 15),
  # Check repeated cols, rows and max and min thresholds
  row_duplicates = TRUE, col_duplicates = TRUE,
  max_threshold_test = list(malaria_tests = 1000, cholera_tests = 1000),
 min_threshold_test = list(cholera_cases = 0, cholera_cases = 0)
)

result <- my_tests(fake_epi_df_togo)