vec_check: Checks that two vectors are the same

In rstudio/tblcheck: Grade Tables in Learning Exercises

Checks that two vectors are the same

Description

Checks for differences between object and expected in the following order:

1. Check class with vec_check_class()

2. Check length with vec_check_dimensions()

3. If the vector is a factor, check factor levels are the same with vec_check_levels()

4. Check vector values are the same with vec_check_values()

5. Check names with vec_check_names()

If the vectors differ

• vec_check() returns a list describing the problem

• vec_grade() returns a failing grade and informative message with gradethis::fail()

Usage

vec_check(
  object = .result,
  expected = .solution,
  check_class = TRUE,
  ignore_class = NULL,
  check_length = TRUE,
  check_levels = TRUE,
  check_values = TRUE,
  tolerance = sqrt(.Machine$double.eps),
  check_names = TRUE,
  env = parent.frame()
)

vec_grade(
  object = .result,
  expected = .solution,
  max_diffs = 3,
  check_class = TRUE,
  ignore_class = NULL,
  check_length = TRUE,
  check_levels = TRUE,
  check_values = TRUE,
  tolerance = sqrt(.Machine$double.eps),
  check_names = TRUE,
  env = parent.frame(),
  ...
)

Arguments

object	A vector to be compared to expected.
expected	A vector containing the expected result.
check_class	[logical(1)] Whether to check that object and expected have the same classes.
ignore_class	[character()] A vector of classes to ignore when finding differences between object and expected. If an element is named, differences will only be ignored between the pair of the element and its name. For example, ignore_class = c("integer" = "numeric") will ignore class differences only if object has class integer and expected has class numeric, or vice versa. If all the classes of expected are included in ignore_class, a class problem will never be returned.
check_length	[logical(1)] Whether to check that object and expected have the same length.
check_levels	[logical(1)] Whether to check that object and expected have the same factor levels.
check_values	[logical(1)] Whether to check that object and expected contain the same values.
tolerance	[numeric(1) ≥ 0] values differences smaller than tolerance are ignored. The default value is close to 1.5e-8.
check_names	[logical(1)] Whether to check that object and expected have the same names.
env	The environment in which to find .result and .solution.
max_diffs	[numeric(1)] The maximum number of mismatched values to print. Defaults to 3.
...	Arguments passed on to gradethis::fail hint Include a code feedback hint with the failing message? This argument only applies to fail() and fail_if_equal() and the message is added using the default options of give_code_feedback() and maybe_code_feedback(). The default value of hint can be set using gradethis_setup() or the gradethis.fail.hint option. encourage Include a random encouraging phrase with random_encouragement()? The default value of encourage can be set using gradethis_setup() or the gradethis.fail.encourage option.

Value

If there are any issues, a list from vec_check() or a gradethis::fail() message from vec_grade(). Otherwise, invisibly returns NULL.

Problems

1. class: object doesn't have the same classes as expected.

2. length: object doesn't have the same length as expected.

3. levels_n, levels, levels_reversed, levels_order: See vec_check_levels().

4. values: object doesn't contain the same values as expected.

5. names: object has different names than expected.

6. names_order: object has the same names as expected, but in a different order.

Examples

.result <- 1:10
.solution <- letters[1:10]
vec_check()
vec_grade()

.result <- 1:10
.solution <- 1:11
vec_check()
vec_grade()

.result <- 1:10
.solution <- rlang::set_names(1:10, letters[1:10])
vec_check()
vec_grade()
vec_grade(max_diffs = 5)
vec_grade(max_diffs = Inf)

.result <- 1:10
.solution <- 11:20
vec_check()
vec_grade()
vec_grade(max_diffs = 5)
vec_grade(max_diffs = Inf)

rstudio/tblcheck documentation built on March 11, 2023, 5:42 p.m.