epicR-config: epicR Configuration Management

In epicR: Evaluation Platform in Chronic Obstructive Pulmonary Disease

epicR Configuration Management

Description

The epicR package now supports user-customizable configuration files. When the package is loaded for the first time, configuration files are automatically copied to a user-specific directory following CRAN policy. You can modify these files to customize model parameters for your specific region or research needs.

Configuration Directory

User configuration files are stored in a platform-specific location determined by tools::R_user_dir("epicR", "config"). Use get_user_config_dir() to find the exact path on your system.

Available Functions

• get_user_config_dir: Get the path to user config directory

• user_config_exists: Check if a user config exists

• copy_configs_to_user: Copy default configs to user directory

• reset_user_configs: Reset configs to package defaults

• list_available_jurisdictions: List available config jurisdictions

• validate_config: Validate a configuration file

Usage

The package automatically uses user configs if they exist. When you call get_input(), it will:

1. First check for user config files in the user config directory

2. If found, use the user's customized configuration

3. If not found, fall back to package default configurations

Customizing Configurations

To customize configurations for your region:

1. The config files are automatically copied on first package load

2. Edit the JSON files (e.g., 'config_canada.json', 'config_us.json')

3. Save your changes

4. The next time you use get_input(), your changes will be used

Adding New Jurisdictions

To add a new jurisdiction:

1. Copy an existing config file (e.g., 'config_canada.json')

2. Rename it to 'config_yourcountry.json'

3. Update the "jurisdiction" field in the JSON to match

4. Modify all parameters as needed for your region

5. Use with: get_input(jurisdiction = "yourcountry")

Resetting to Defaults

If you need to reset your configurations:

• Reset all configs: reset_user_configs()

• Reset specific jurisdiction: reset_user_configs("canada")

Examples

# Check where user configs are stored
get_user_config_dir()

# List available jurisdictions
list_available_jurisdictions()

# Validate your custom config
validate_config("canada", user = TRUE)

# Reset to package defaults if needed
reset_user_configs("canada")

# Use your custom config
input <- get_input(jurisdiction = "canada")

epicR documentation built on March 8, 2026, 5:06 p.m.