assert_cols: Assert data frame columns

In salim-b/pal: Friendly Convenience/Utility Functions

Assert data frame columns

Description

Asserts that a data frame contains the specified columns.

Usage

assert_cols(
  data,
  cols = NULL,
  strict = FALSE,
  obj_name = checkmate::vname(data)
)

Arguments

data	Data frame to check.
cols	Column names which must be present in data. A character vector or NULL.
strict	Whether additional columns not specified in cols are allowed in data.
obj_name	Name of the checked object to print in error messages.

Value

data, invisibly.

See Also

Other data frame / tibble functions: is_equal_df(), reduce_df_list()

Examples

pal::assert_cols(data = mtcars,
                 cols = c("mpg", "disp"))

try(
  pal::assert_cols(data = mtcars,
                   cols = c("mpg", "display"))
)

try(
  pal::assert_cols(data = mtcars,
                   cols = c("mpg", "disp"),
                   strict = TRUE)
)

try(
  pal::assert_cols(data = mtcars,
                   strict = TRUE)
)

salim-b/pal documentation built on Feb. 28, 2025, 6:51 p.m.