nordcan_statistics_tables: NORDCAN Statistics Tables

In CancerRegistryOfNorway/nordcanepistats: NORDCAN Epidemiological Statistics

NORDCAN Statistics Tables

Description

Compute all necessary statistics for NORDCAN into a single list of tables.

Usage

nordcan_statistics_tables(
  cancer_record_dataset,
  cancer_death_count_dataset,
  general_population_size_dataset,
  national_population_life_table,
  stata_exe_path,
  output_objects = NULL,
  subset = NULL,
  survival_test_sample = FALSE,
  survival_trace = FALSE
)

nordcan_statistics_tables_output_object_space()

Arguments

cancer_record_dataset	⁠[data.table]⁠ (mandatory, no default) as output by nordcanpreprocessing::nordcan_processed_cancer_record_dataset
cancer_death_count_dataset	⁠[data.table]⁠ (mandatory, no default) dataset containing numbers of cancer deaths; see Details
general_population_size_dataset	⁠[data.table]⁠ (mandatory, no default) the dataset of population sizes as per the call for data
national_population_life_table	⁠[data.table]⁠ (mandatory, no default) the life table as per the call for data
stata_exe_path	⁠[character]⁠ (mandatory, no default) pased of Stata for conducting survival analysis
output_objects	⁠[NULL, character]⁠ (optional, default NULL) this argument can be used to select which elements of the output list to produce in this function. NULL: no limit, i.e. produce everything character: vector of element names to produce (only); see section Value and nordcan_statistics_tables_output_object_space() for all options

Details

nordcan_statistics_tables_output_object_space simply returns a character vector of possible names of the list output by nordcan_statistics_tables

Value

The output is a list with elements:

• "session_info": Log of current time and R session info as output by sessionInfo()

• "cancer_death_count_dataset": The same dataset returned as-is as given to arg cancer_death_count_dataset

• "general_population_size_dataset": The same dataset returned as-is as given to arg general_population_size_dataset

• "cancer_record_count_dataset": Dataset of cancer record counts computed using nordcanepistats::nordcanstat_count

• "prevalent_patient_count_dataset": Dataset of prevalent cancer patients counts computed using nordcanepistats::nordcanstat_year_based_prevalent_patient_count

• "imp_quality_general_statistics_dataset": Quality statistics computed using nordcanepistats::nordcanstat_imp_quality

• "imp_quality_exclusion_statistics_dataset": Quality statistics computed using nordcanepistats::nordcanstat_imp_quality

• "survival_quality_statistics_dataset": Quality statistics computed using nordcanepistats::nordcanstat_survival_quality

• "stata_info": Info about stata as returned by nordcansurvival::get_stata_info

• "survival_statistics_agestandardised_survivaltime_05_period_05": 5 year "age_standarized" survival statistics based on 5-year period;

• "survival_statistics_agestandardised_survivaltime_05_period_10": 5 year "age_standarized" survival statistics based on 10-year period;

• "survival_statistics_agestandardised_survivaltime_10_period_05": 10 year "age_standarized" survival statistics based on 5-year period;

• "survival_statistics_agestandardised_survivaltime_10_period_10": 10 year "age_standarized" survival statistics based on 10-year period;

• "survival_statistics_agespecific_survivaltime_05_period_05": 5 year "age_specific" survival statistics based on 5-year period;

• "survival_statistics_agespecific_survivaltime_05_period_10": 5 year "age_specific" survival statistics based on 10-year period;

• "survival_statistics_agespecific_survivaltime_10_period_05": 10 year "age_specific" survival statistics based on 5-year period;

• "survival_statistics_agespecific_survivaltime_10_period_10": 10 year "age_specific" survival statistics based on 10-year period;

unless argument output_objects is used to limit the output elements.

Examples

## Not run: 
nc_stats <- nordcan_statistics_tables(
 cancer_record_dataset = crd,
 cancer_death_count_dataset = cdcd,
 general_population_size_dataset = gpsd,
 national_population_life_table = lt,
 stata_exe_path = "stata.exe"
)

## End(Not run)

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