tests/testthat/test_04_get_births.R

In PADeCI/demogmx: Demographic data for Mexico

# Activate Libraries ------------------------------------------------------
library(demogmx)
library(dplyr)
library(testthat)


# Start unit tests --------------------------------------------------------
## Correct inputs ---------------------------------------------------------
test_that("correct inputs are valid", {
  # Valid parameter set
  expect_silent(get_births(v_state = c("National", "Mexico City"),
                           v_year = 1976,
                           year_groups = TRUE))
})


### State inputs ----------------------------------------------------------
test_that("state inputs are correct", {
  # Error in v_state
  expect_error(get_births(v_state = "national", #National <- correct
                          v_year = 1976,
                          year_groups = TRUE),
               regexp = paste('v_state must be a character element or vector containing at least one of the next names:',
                              paste(unique(df_birth_pop_states$state), collapse = ", "),
                              sep = "\n\n") )

  # Not an exact match
  expect_error(get_births(v_state = c("National", "Ags"), # Aguascalientes
                          v_year = 1976,
                          year_groups = TRUE),
               regexp = paste('v_state must be a character element or vector containing at least one of the next names:',
                              paste(unique(df_birth_pop_states$state), collapse = ", "),
                              sep = "\n\n"))

  # Not a character
  expect_error(get_births(v_state = 65,
                          v_year = 1976,
                          year_groups = TRUE),
               regexp = paste('v_state must be a character element or vector containing at least one of the next names:',
                              paste(unique(df_birth_pop_states$state), collapse = ", "),
                              sep = "\n\n"))

  # Multiple errors
  expect_error(get_births(v_state = c("national", "Ags"), # Aguascalientes
                          v_year = 1976,
                          year_groups = TRUE),
               regexp = paste('v_state must be a character element or vector containing at least one of the next names:',
                              paste(unique(df_birth_pop_states$state), collapse = ", "),
                              sep = "\n\n"))
})


### Year inputs -----------------------------------------------------------
test_that("year inputs are correct", {
  # Outside bounds [1970, 2050]
  expect_error(get_births(v_state = c("National", "Aguascalientes"),
                          v_year = 1905,
                          year_groups = TRUE),
               regexp = "v_year must be a integer value or vector with values between 1970 and 2050")

  # Not an integer
  expect_error(get_births(v_state = c("National", "Aguascalientes"),
                          v_year = 1985.6,
                          year_groups = TRUE),
               regexp = "v_year must be a integer value or vector with values between 1970 and 2050")

  expect_error(get_births(v_state = c("National", "Aguascalientes"),
                          v_year = c(2000, 2010.6),
                          year_groups = TRUE),
               regexp = "v_year must be a integer value or vector with values between 1970 and 2050")

  # Not a number
  expect_error(get_births(v_state = c("National", "Aguascalientes"),
                          v_year = "aa",
                          year_groups = TRUE),
               regexp = "v_year must be a integer value or vector with values between 1970 and 2050")
})

### Year groups inputs ----------------------------------------------------
test_that("year groups are correct", {
  # age groups is not a logical variable
  expect_error(get_births(v_state = c("National", "Aguascalientes"),
                          v_year = c(2000, 2010, 2025),
                          year_groups = 55),
               regexp = "year_groups must be a logical value (TRUE / FALSE)",
               fixed = TRUE)

  # Length of year_groups greater than one
  expect_warning(get_births(v_state = c("National", "Aguascalientes"),
                            v_year = c(2000, 2010, 2025),
                            year_groups = c(TRUE, FALSE)))
})


## Correct outputs --------------------------------------------------------
### All possible vars -----------------------------------------------------

test_that("the output is correct when all the available vars are selected", {

  df_gb <- get_births(v_state = unique(df_birth_pop_states$state),
                       v_year = seq(from = 1970, to = 2050, by = 1),
                       year_groups = FALSE) # It has to be FALSE

  # It should have the same number of rows of the expanded migration dataset
  expect_equal(dim(df_gb)[1], dim(df_birth_pop_states)[1])
})



### Correct dimensions ----------------------------------------------------
test_that("the ungrouped output has the correct dimensions", {
  # Ungrouped
  df_gb <- get_births(v_state = c("Guerrero", "Mexico City"),
                      v_year = seq(from = 1970, to = 2050, by = 1),
                      year_groups = FALSE)

  years  <- 81
  states <- 2
  size <- years*states

  expect_equal(dim(df_gb)[1], size)

  # Grouped by years
  df_gb <- get_births(v_state = c("Guerrero", "Mexico City"),
                      v_year = seq(from = 1970, to = 2050, by = 10),
                      year_groups = TRUE)

  years_grp  <- 8
  states_grp <- 2
  size_grp <- years_grp*states_grp

  expect_equal(dim(df_gb)[1], size_grp)

  # Only one year
  df_gb <- get_births(v_state = c("Guerrero", "Mexico City"),
                      v_year = 2010,
                      year_groups = FALSE)

  years <- 1
  size <- years*states

  expect_equal(dim(df_gb)[1], size)

  # Only one year and on state
  df_gb <- get_births(v_state = "Guerrero",
                      v_year = 2010,
                      year_groups = FALSE)

  years <- 1
  states <- 1
  size <- years*states

  expect_equal(dim(df_gb)[1], size)
})