Package index

CLI Interface

Create command-line interfaces for CHAP models

create_chap_cli()

Create Chap CLI

build_run_info()

Build default run_info object from data

Configuration

Model configuration management

read_model_config()

Read Model Configuration

write_model_config()

Write Model Configuration

get_config_param()

Get Configuration Parameter

create_config_schema()

Create a Model Configuration Schema

validate_config()

Validate Model Configuration Against Schema

apply_config_defaults()

Apply Default Values from Schema to Configuration

get_schema_defaults()

Extract Default Values from Schema

Configuration Schema Builders

Helper functions to build JSON Schema configuration schemas

schema_string()

Define a String Schema Property

schema_number()

Define a Number Schema Property

schema_integer()

Define an Integer Schema Property

schema_boolean()

Define a Boolean Schema Property

schema_array()

Define an Array Schema Property

schema_enum()

Define an Enum Schema Property

schema_to_json()

Convert Schema to JSON

print(<chap_config_schema>)

Print Schema Summary

Model Validation

Test and validate CHAP model implementations

run_model_tests()

Run Model Test Suite

validate_model_io()

Validate Model Input/Output with Example Data

validate_model_io_all()

Validate Model Input/Output for All Available Datasets

validate_model_output()

Validate Model Output

Spatio-Temporal Data

Utilities for working with spatio-temporal data

transform_spatiotemporal()

Transform Spatio-Temporal Data

aggregate_spatial()

Aggregate Spatial Data

aggregate_temporal()

Aggregate Temporal Data

Prediction Samples

Convert between prediction sample formats

predictions_from_wide()

Convert Wide Format Predictions to Nested Format

predictions_to_wide()

Convert Nested Format Predictions to Wide Format

predictions_from_long()

Convert Long Format to Nested Format

predictions_to_long()

Convert Nested Format to Long Format

predictions_to_quantiles()

Compute Quantiles from Prediction Samples

predictions_summary()

Add Summary Statistics to Predictions

has_prediction_samples()

Check if Predictions Have Samples

detect_prediction_format()

Detect Prediction Sample Format

Example Models

Reference model implementations

train_mean_model()

Train a simple mean model

predict_mean_model()

Predict using mean model

Environment

Docker and renv environment configuration for containerized models

init_chap_env()

Initialize Chap model environment

generate_dockerfile()

Generate Dockerfile for Chap model

generate_mlproject()

Generate MLproject file for chap-core compatibility

detect_system_deps()

Detect system dependencies from renv packages

read_renv_r_version()

Environment configuration for Chap models. Read R version from renv.lock

Utilities

Helper functions

get_example_data()

Get Example Data for Testing