any_obj: Validator: Allow any object

In dataclass: Easily Create Structured Lists or Data Frames with Input Validation

Validator: Allow any object

Description

This function is used to bypass dataclass checks for a given element. If you do not want dataclass to check a given element, set the element equal to any_obj() to allow any object. Keep in mind that while dataclass will bypass the check, the object must still be a valid R object. Furthermore, if you are using dataclass to create a tibble, then the object must be a valid tibble column type, even if additional checks are not considered. This can be dangerous because dataclass is designed to check objects, not bypass them. Use this validator sparingly and consider how you can write a stricter dataclass.

Usage

any_obj()

Value

A function with the following properties:

• Always returns TRUE

• Bypasses any dataclass checks

Examples

# Define a dataclass:
my_dataclass <-
  dataclass(
    date_val = dte_vec(),
    anything = any_obj()
  )

# While `date_val` must be a date, `anything` can be any value!
my_dataclass(
  date_val = as.Date("2022-01-01"),
  anything = lm(vs ~ am, mtcars)
)

my_dataclass(
  date_val = as.Date("2022-01-01"),
  anything = c(1, 2, 3, 4, 5)
)

my_dataclass(
  date_val = as.Date("2022-01-01"),
  anything = list(a = 1, b = 2)
)

dataclass documentation built on Sept. 24, 2024, 5:07 p.m.