Man pages for epicR
Evaluation Platform in Chronic Obstructive Pulmonary Disease

calc_event_stack_sizeCalculate recommended event_stack_size for a given number of...
calibrate_COPD_incSolves stochastically for COPD incidence rate equation.
calibrate_explicit_mortalityCalibrates explicit mortality
calibrate_explicit_mortality2Calibrates explicit mortality by Amin
calibrate_smokingCalibrates smoking
copy_configs_to_userCopy default configs to user directory
epicR-configepicR Configuration Management
epicR-package'epicR' package
estimate_memory_requiredEstimate memory required for simulation
export_figuresRuns the model and exports an excel file with all output data
express_matrixExpress matrix.
get_agent_eventsReturns all events of an agent.
get_agent_size_bytesReturns the size of agent struct in bytes
get_all_eventsReturns all events.
get_all_events_matrixReturns a matrix containing all events
get_available_memoryGet available system memory (platform-specific)
get_default_model_inputGet the default model input (lazy initialization)
get_default_settingsExports default settings
get_errorsReturns errors
get_eventReturns the events stack.
get_events_by_typeReturns all events of a certain type.
get_inputReturns a list of default model input values
get_inputsReturns inputs
get_list_elementsGet list elements
get_n_eventsReturns total number of events.
get_outputMain outputs of the current run.
get_output_exExtra outputs from the model
get_progressReturns current simulation progress.
get_runtime_statsReturns run time stats.
get_sample_outputReturns a sample output for a given year and gender.
get_settingsReturns current settings.
get_smithReturns agent Smith.
get_user_config_dirGet user config directory path
init_sessionInitializes a model. Allocates memory to the C engine.
list_available_jurisdictionsList available config jurisdictions
mvrnormArmaSamples from a multivariate normal
report_COPD_by_ctimeReports COPD related stats.
report_exacerbation_by_timeReports exacerbation-related stats.
reset_model_inputReset the cached model input
reset_user_configsReset user configs to package defaults
resumeResumes running of model.
sanity_checkBasic tests of model functionality. Serious issues if the...
sanity_COPDBasic COPD test.
set_input_varSets input variables.
set_settings_varSets model settings.
simulateConvenience function: run simulation and return results
terminate_sessionTerminates a session and releases allocated memory.
test_case_detectionReturns results of Case Detection strategies
user_config_existsCheck if user config exists
validate_configValidate a config file
validate_COPDReturns results of validation tests for COPD
validate_diagnosisReturns results of validation tests for diagnosis
validate_exacerbationReturns results of validation tests for exacerbation rates
validate_gpvisitsReturns results of validation tests for GP visits
validate_lung_functionReturns results of validation tests for lung function
validate_medicationReturns results of validation tests for medication module.
validate_mortalityReturns results of validation tests for mortality rate
validate_overdiagnosisReturns results of validation tests for overdiagnosis
validate_payoffsReturns results of validation tests for payoffs, costs and...
validate_populationReturns simulated vs. predicted population table and a plot
validate_smokingReturns results of validation tests for smoking module.
validate_survivalReturns the Kaplan Meier curve comparing COPD and non-COPD
validate_symptomsReturns results of validation tests for Symptoms
validate_treatmentReturns results of validation tests for Treatment
epicR documentation built on March 8, 2026, 5:06 p.m.