assert_ds_is_valid: Assert dataset is valid

In ready4-dev/youthvars: Describe and Validate Youth Mental Health Economic Datasets

Assert dataset is valid

Description

assert_ds_is_valid() is an Assert function that validates that an object conforms to required condition(s). If the object does not meet all required conditions, program execution will be stopped and an error message provided. Specifically, this function implements an algorithm to assert dataset is valid. The function is called for its side effects and does not return a value.

Usage

assert_ds_is_valid(
  data_tb,
  id_var_nm_1L_chr,
  round_var_nm_1L_chr,
  round_bl_val_1L_chr,
  msrmnt_date_var_nm_1L_chr = NULL
)

Arguments

data_tb	Data (a tibble)
id_var_nm_1L_chr	Identity variable name (a character vector of length one)
round_var_nm_1L_chr	Round variable name (a character vector of length one)
round_bl_val_1L_chr	Round baseline value (a character vector of length one)
msrmnt_date_var_nm_1L_chr	Measurement date variable name (a character vector of length one), Default: NULL

Value

No return value, called for side effects.

ready4-dev/youthvars documentation built on Nov. 15, 2024, 6:02 a.m.