vvauditor (version 0.7.0)

assert_logical_named: Assert Logical Value in Column

Description

This function asserts that the values in a specified column of a data frame are logical. It uses the checkmate::assert_logical function to perform the assertion.

Usage

assert_logical_named(column, df, prefix_column = NULL, ...)

Value

None

Arguments

column

A character vector or string with the column name to be tested.

df

The data frame that contains the column.

prefix_column

A character string that will be prepended to the column name in the assertion message. Default is NULL.

...

Additional parameters are passed to the checkmate::assert_logical function.

Examples

# Create a data frame
df <- data.frame(a = c(TRUE, FALSE, TRUE, FALSE), b = c(1, 2, 3, 4))
# Assert that the values in column "a" are logical
assert_logical_named("a", df)