omopgenerics (version 1.4.1)

validateResultArgument: Validate whether an object is a valid 'summarised_result' object.

Description

Validate whether an object is a valid 'summarised_result' object.

Usage

validateResultArgument(
  result,
  checkNoDuplicates = FALSE,
  checkNameLevel = FALSE,
  checkSuppression = FALSE,
  empty = TRUE,
  validation = "error",
  nm = deparse1(substitute(result), backtick = TRUE),
  call = parent.frame()
)

Value

A summarised_result object.

Arguments

result

summarised_result object to validate.

checkNoDuplicates

Whether duplicates are not allowed in the result object.

checkNameLevel

Whether the name-level paired columns can be correctly split.

checkSuppression

Whether the suppression in the result object is well defined.

empty

Whether it can be empty.

validation

Only error is supported at the moment.

nm

Name to use in error messages. Defaults to the expression supplied to result.

call

Call argument passed to cli functions.

Examples

x <- dplyr::tibble(
  "result_id" = 1L,
  "cdm_name" = "eunomia",
  "group_name" = "cohort_name",
  "group_level" = "my_cohort",
  "strata_name" = c("sex", "sex &&& age_group", "sex &&& year"),
  "strata_level" = c("Female", "Male &&& <40", "Female &&& 2010"),
  "variable_name" = "number subjects",
  "variable_level" = NA_character_,
  "estimate_name" = "count",
  "estimate_type" = "integer",
  "estimate_value" = c("100", "44", "14"),
  "additional_name" = "overall",
  "additional_level" = "overall"
) |>
  newSummarisedResult()

validateResultArgument(x)