shg_params_summary: Summarize currently configured SHG parameter tables

In SmokingHistoryGenerator: R Package for the Smoking History Generator

Summarize currently configured SHG parameter tables

Description

Returns a compact "shape" summary of the currently configured parameter files (races, sexes, cohorts, age ranges, and CPD coverage). This works after either shg_load_params() or manual file-path configuration on an SHGInterface instance.

Usage

shg_params_summary(shg)

Arguments

shg	An SHGInterface instance.

Value

A named list with nested sections initiation, cessation, mortality, and cpd, plus top-level dimensions/cohort metadata for convenience.

The cpd$note field summarizes whether initiation rows below the CPD minimum age are effectively ignorable (all zeros and/or dots), or if there are non-zero initiation values that may indicate a mismatch.

Examples

shg <- new(SHGInterface)
shg$input_data_folder <- system.file("extdata", "2018", package = "SmokingHistoryGenerator")
shg_params_summary(shg)

SmokingHistoryGenerator documentation built on June 13, 2026, 1:08 a.m.