global_nordcan_settings: NORDCAN Settings

In CancerRegistryOfNorway/nordcancore: NORDCAN Core Utilities and Metadata

NORDCAN Settings

Description

Set and get settings for NORDCAN software.

Usage

set_global_nordcan_settings(
  work_dir,
  participant_name,
  first_year_incidence,
  first_year_mortality,
  first_year_region,
  last_year_incidence,
  last_year_mortality,
  last_year_survival
)

get_global_nordcan_settings()

Arguments

work_dir	⁠[character]⁠ (mandatory, no default) root directory for any and all (temporarily) stored NORDCAN data; if it does not exist it is attempted to be created
participant_name	⁠[character]⁠ (mandatory, no default) name of NORDCAN participant; e.g. "Denmark" or "Sweden"
first_year_incidence	⁠[integer]⁠ (mandatory, no default) first year for which to compute the cancer record count statistics; e.g. 1953L
first_year_mortality	⁠[integer]⁠ (mandatory, no default) first year for the cancer death count statistics; e.g. 1953L
first_year_region	⁠[integer]⁠ (mandatory, no default)
last_year_incidence	⁠[integer]⁠ (mandatory, no default) Last year for which to compute the cancer record count statistics; e.g. 2019L
last_year_mortality	⁠[integer]⁠ (mandatory, no default) Last year for the cancer death count statistics; e.g. 2019L
last_year_survival	⁠[integer]⁠ (mandatory, no default) Last year for survival analysis; e.g. 2019L

Details

Some first years for statistics are set using set_global_nordcan_settings. However, the first year for survival is fixed to nordcancore::global_settings_env[["last_year_survival"]] - 29L. Likewise the first year for prevalence is fixed to first_year_incidence + 20L.

CancerRegistryOfNorway/nordcancore documentation built on April 29, 2024, 4:40 p.m.