Check the class of 'canreg' — check

Provides data structure validation tools for cancer registry objects. Includes the generic function check_canreg() and its methods for objects of class canreg and canregs, which check for essential components in cancer incidence and population data. Supporting functions check_FBcases(), check_SWcases(), and check_pop() assess the presence of required variables, structural completeness, and validity of data values such as age groups, sex codes, and population counts.

check_canreg(data, pop_type = "long")

# S3 method for class 'canregs'
check_canreg(data, pop_type = "long")

# S3 method for class 'canreg'
check_canreg(data, pop_type = "long")

Arguments

data: Object with class of 'canreg' or 'canregs'.
pop_type: Type of population data, either "single" or "long". Defaults to "long".

Value

A list of class "check" (or "checks" for canregs objects) containing results of data structure validation.

Examples

data("canregs")
check <- check_canreg(canregs)
check <- check_canreg(canregs[[1]])