nordcanstat_year_based_prevalent_patient_count: Prevalence

In CancerRegistryOfNorway/nordcanepistats: NORDCAN Epidemiological Statistics

Prevalence

Description

Compute numbers of people alive at specific time points who have had a cancer diagnosis in their past.

Usage

nordcanstat_year_based_prevalent_patient_count(
  x,
  by = NULL,
  entities = NULL,
  observation_years = NULL,
  subset = NULL,
  subset_style = "zeros"
)

Arguments

x	⁠[data.table]⁠ (mandatory, no default) the NORDCAN cancer record dataset after preprocessing; see also the underlying implementation basicepistats::stat_count
by	see basicepistats::stat_count exceptions to ⁠[basicepistats::stat_count]⁠: if by is a character vector of column names in x, the allowed combinations of those columns are retrieved using ⁠[nordcancore::nordcan_metadata_column_level_space_dt]⁠, and the output will include all of these combinations if by is a character vector and one element of it is "entity", then output is also stratified by entity number (the entity numbers will be in column entity in output); the entities to compute results by are supplied via entities if by is a character vector and one element of it is "region", then output is also stratified by region number, i.e. by every sub-region (if applicable) and also the top region
entities	⁠[NULL, integer]⁠ (optional, default NULL) see by for how to stratify output by entity number. NULL: output of nordcancore::nordcan_metadata_entity_no_set("all") is used integer: these entity numbers are used
observation_years	⁠[NULL, integer]⁠ (optional, default NULL) NULL: NORDCAN default set of years is used integer: only observe prevalence at the ends of these years; see basicepistats::stat_year_based_prevalent_subject_count for more information
subset	see basicepistats::stat_year_based_prevalent_subject_count
subset_style	see basicepistats::stat_year_based_prevalent_subject_count

See Also

Other nordcanstat: nordcanstat_count(), nordcanstat_imp_quality(), nordcanstat_survival_quality()

CancerRegistryOfNorway/nordcanepistats documentation built on June 3, 2024, 5:41 p.m.