create_canradar_summary_file: Compute summary statistics from 5 years age-group cancer...

In cancerradarr: Cancer RADAR Project Tool

Compute summary statistics from 5 years age-group cancer registry data

Description

Compute summary statistics from 5 years age-group cancer registry data

Usage

create_canradar_summary_file(
  filename.in,
  filename.out,
  ncan.min = 5,
  include.by.cob.stat = TRUE,
  verbose = TRUE
)

Arguments

filename.in	file path, the file containing the 5 years age counts of cancers stratified per cancer type, sex and country of birth
filename.out	file path, the file where summary .xlsx file will be save
ncan.min	integer, the minimum number of cancer per age group o be displayed
include.by.cob.stat	logical, (TRUE by default) should the statistic per country-of-birth be computed and included in the output file.
verbose	logical, shall progress message be printed

Value

a .xlsx with all the summary statistics needed for Cancer RADAR project to be transmitted to project PIs.

Examples

  ## Update file.in with the path to the input file containing your registry data
  ## (e.g. file.filled <- "cancerRADAR_input.xlsx")
  file.in <- system.file("extdata", "ex_cancerRADAR_input_filled.xlsx", package = "cancerradarr")
  file.out <- 'cancerRADAR_input.xlsx'
  ## for cancer radar data submission, we advise to use the parameter ncan.min = 5 and 
  ## include.by.cob.stat = TRUE
  create_canradar_summary_file(file.in, file.out, ncan.min = 20, include.by.cob.stat = FALSE)
  ## remove the file to pass package computation tests
  unlink(file.out)

cancerradarr documentation built on Aug. 8, 2025, 7:28 p.m.