Skip to contents

Summary a summarised_result

Usage

# S3 method for class 'summarised_result'
summary(object, ...)

Arguments

object

A summarised_result object.

...

For compatibility (not used).

Value

A summary of the result_types contained in a summarised_result object.

Examples

library(dplyr, warn.conflicts = FALSE)

person <- tibble(
  person_id = 1, gender_concept_id = 0, year_of_birth = 1990,
  race_concept_id = 0, ethnicity_concept_id = 0
 )
observation_period <- tibble(
  observation_period_id = 1, person_id = 1,
  observation_period_start_date = as.Date("2000-01-01"),
  observation_period_end_date = as.Date("2023-12-31"),
  period_type_concept_id = 0
)
cdm <- cdmFromTables(
  tables = list("person" = person, "observation_period" = observation_period),
  cdmName = "test"
)
#> Warning: ! 5 column in person do not match expected column type:
#>  `person_id` is numeric but expected integer
#>  `gender_concept_id` is numeric but expected integer
#>  `year_of_birth` is numeric but expected integer
#>  `race_concept_id` is numeric but expected integer
#>  `ethnicity_concept_id` is numeric but expected integer
#> Warning: ! 3 column in observation_period do not match expected column type:
#>  `observation_period_id` is numeric but expected integer
#>  `person_id` is numeric but expected integer
#>  `period_type_concept_id` is numeric but expected integer

result <- summary(cdm)

summary(result)
#> A summarised_result object with 13 rows, 1 different result_id, 1 different cdm
#> names, and 3 settings.
#> CDM names: test.
#> Settings: package_name, package_version, and result_type.