Runner — dsambayesplus Documentation

CLI Usage

Mon, 01 Jan 0001 00:00:00 +0000

Purpose Define the supported command-line interface for scripts/dsambayesplus.R, including required flags, optional flags, and execution semantics. Prerequisites Before using the CLI: Complete Install and Setup. Run commands from repository root. Ensure dsambayesplus is installed in the role-specific R_LIBS_USER selected by dsambayesplus_set_r_library host. Entry point Rscript scripts/dsambayesplus.R [flags] Operational commands construct the package-owned dsambayesplus::runner_cli_adapter() before reading configs, fitting models, or writing artefacts. The startup panel records both the loaded package version and the checkout version from DESCRIPTION. runme.R applies the same gate and records the versions as package_version and checkout_version.

Config Schema

Mon, 01 Jan 0001 00:00:00 +0000

Purpose This page documents the authored YAML contract used by: scripts/dsambayesplus.R dsambayesplus::run_from_yaml() runme.R The authored schema is schema_version: 2 only. Older formula-driven YAML files are intentionally rejected. Processing order The runner processes configs in this order: Parse YAML. Coerce YAML infinity tokens (.Inf, -.Inf). Apply v2 defaults. Resolve relative paths against the config file directory. Validate the authored v2 contract. Compile the authored config into the internal runner config. Apply managed holiday terms, then build the model and run. Root sections Key Required Purpose schema_version yes Must be 2. data yes Input data path, format, and date handling. target yes Outcome column, KPI type, and response transform. media yes Modeled media terms. controls yes Non-media predictors, including manual trend/seasonality terms. effects no Managed effects. In M1 this is holidays only. model yes Model class and scaling options. fixed_effects conditional Required exactly for model.type: fe. hierarchy conditional Required for model.type: re and model.type: cre. pooling conditional Required for model.type: pooled. priors no Default priors plus grouped or explicit overrides. boundaries no Grouped or explicit parameter boundaries. fit no MCMC or optimise settings. diagnostics no Diagnostics, model selection, and time-series selection settings. allocation no Budget optimisation settings. outputs no Output paths and artifact toggles. forecast no enabled defaults to false; true is rejected because the runner has no forecast-output contract. Unknown keys fail validation.

Output Artefacts

Mon, 01 Jan 0001 00:00:00 +0000

Purpose This page defines what the YAML runner writes, where files are written, and which config flags control each artefact. Related pages: CLI Usage Config Schema Run directory and layout semantics Run directory precedence: CLI --run-dir outputs.run_dir Timestamped folder under outputs.root_dir Layout behaviour: