vec_check_levels: Check that the levels of two factors are the same

In rstudio/tblcheck: Grade Tables in Learning Exercises

Check that the levels of two factors are the same

Description

Checks if object and expected have the same levels. If the levels differ

• vec_check_levels() returns a list describing the problem

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

Usage

vec_check_levels(object = .result, expected = .solution, env = parent.frame())

vec_grade_levels(
  object = .result,
  expected = .solution,
  max_diffs = 3,
  env = parent.frame(),
  ...
)

Arguments

object	An object to be compared to expected.
expected	An object containing the expected result.
env	The environment in which to find .result and .solution.
max_diffs	[numeric(1)] The maximum number of missing and/or unexpected names to include in an informative failure message. 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_levels() or a gradethis::fail() message from vec_grade_levels(). Otherwise, invisibly returns NULL.

Problems

1. levels_n: object and expected have a different number of levels.

2. levels: The object has levels that are not expected, or is missing levels that are expected.

3. levels_reversed: The levels of object are in the opposite order of expected.

4. level_order: The levels of object are not in the same order as expected.

Examples

.result <- as.factor(rep_len(letters[1:3], 6))
.solution <- as.factor(rep_len(letters[1:2], 6))
vec_check_levels()
vec_grade_levels()

.result <- as.factor(letters[1:6])
.solution <- as.factor(letters[21:26])
vec_check_levels()
vec_grade_levels()
vec_grade_levels(max_diffs = 5)
vec_grade_levels(max_diffs = Inf)

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