/index.html Documentation for DSAMbayes v1.3.3 — a Bayesian marketing mix modelling toolkit for R, built on Stan. DSAMbayes provides a unified interface for building, fitting, and interpreting MMM models. It supports single-market regression (BLM), multi-market hierarchical models with partial pooling, and pooled models with structured media coefficients. All model types share the same post-fit interface for posterior extraction, diagnostics, decomposition, and budget optimisation. The docs are organised around a simple idea: DSAMbayes is not just an API or a runner. It is a way of operating a principled Bayesian MMM workflow with explicit assumptions, diagnostic gates, and decision rules. Hugo en-gb /getting-started/index.html Mon, 01 Jan 0001 00:00:00 +0000 /getting-started/index.html Purpose Onboard a new user from install to first successful DSAMbayes run, then point them into the workflow guidance needed for serious modelling use. Audience New DSAMbayes users. Analysts running DSAMbayes through R scripts or CLI. Recommended route Install and Setup Quickstart (YAML Runner) Principled Bayesian Workflow Your First BLM Model or Your First Hierarchical Model If you are coming from classical econometrics, read Frequentist to Bayesian Translation before customising priors or interpreting diagnostics. /workflow/index.html Mon, 01 Jan 0001 00:00:00 +0000 /workflow/index.html Purpose Give DSAMbayes users a workflow-shaped mental model for Bayesian MMM. This section is the methodological spine of the docs: it explains the sequence of decisions, assumptions, and diagnostic gates that should sit behind any DSAMbayes run. Audience Econometricians moving from OLS or other frequentist MMM workflows into Bayesian modelling. Analysts who know how to run DSAMbayes but want a more defensible modelling process. Reviewers who need to understand what a “good” DSAMbayes run should have passed before interpretation. Why this section exists DSAMbayes already documents its runner, model classes, priors, and diagnostics in detail. What most users still need is a clear answer to: /runner/index.html Mon, 01 Jan 0001 00:00:00 +0000 /runner/index.html Purpose Document CLI and YAML runner contracts for reproducible DSAMbayes runs. Audience Users operating DSAMbayes through scripts/dsambayes.R. Engineers maintaining runner config and artefact contracts. Pages Page Topic CLI Usage Commands, flags, exit codes, and error modes Config Schema YAML keys, defaults, and validation rules Output Artefacts Staged folder layout, file semantics, and precedence rules /modelling/index.html Mon, 01 Jan 0001 00:00:00 +0000 /modelling/index.html Purpose Describe model classes, inference contracts, diagnostics, and decision-layer semantics for DSAMbayes. This section is primarily reference material; use Principled Bayesian Workflow for the methodology spine. Audience Practitioners building and interpreting DSAMbayes models. Reviewers validating modelling assumptions and outputs. Pages Page Topic Model Classes BLM, hierarchical, and pooled class constructors, fit support, and limitations Model Object Lifecycle State transitions from construction through fitting to post-fit extraction Priors and Boundaries Prior schema, defaults, overrides, boundary controls, and scale semantics Minimal-Prior Policy Governance guidance for prior specification in MMM Response Scale Semantics Identity vs log response, KPI-scale conversion, Jensen-safe reporting Diagnostics Gates Policy modes, threshold tables, identifiability gate, and remediation actions CRE / Mundlak Correlated random effects for hierarchical models Time Components Managed holiday feature generation and weekly anchoring Budget Optimisation Decision-layer budget allocation, objectives, risk scoring, and response transforms /plots/index.html Mon, 01 Jan 0001 00:00:00 +0000 /plots/index.html Purpose This section documents every plot the DSAMbayes runner produces. Each page covers one pipeline stage, describes what the plot shows, explains when and why the runner generates it, and gives practical interpretation guidance. The target reader is a modelling operator or analyst who needs to assess run quality without reading source code. Pipeline stages The runner writes artefacts into timestamped directories under results/. Plots are organised into six stages, each with its own subdirectory: /how-to/index.html Mon, 01 Jan 0001 00:00:00 +0000 /how-to/index.html Purpose Provide task-oriented recipes for common DSAMbayes operational workflows. Each guide starts from a user objective, gives minimal reproducible steps, and includes expected output artefacts and quick verification checks. Audience Users who know the concepts but need execution steps. Engineers debugging run and artefact issues. Pages Guide Objective Run from YAML Execute a complete runner workflow and verify staged outputs Interpret Diagnostics Read and act on diagnostics gate results Compare Runs Compare multiple runs and select a candidate model Debug Run Failures Diagnose and resolve common runner failure modes /appendices/index.html Mon, 01 Jan 0001 00:00:00 +0000 /appendices/index.html Purpose Provide reference material that supports core user guidance without duplicating operational instructions. Audience Readers needing precise terminology definitions Engineers orienting themselves in R/ source modules Reviewers validating implementation traceability Pages Glossary: canonical DSAMbayes terminology. R Module Index: logical map of package source files. Traceability Map: how to map issues and recommendations to implementation evidence. Usage rules Use appendices as reference pages, not primary process documentation. Keep operational runbooks in docs/getting-started/, docs/runner/, and docs/internal/. Prefer links to authoritative sources instead of duplicating constraints or commands. Related sections Getting Started Runner Modelling Internal (Engineering) /internal/index.html Mon, 01 Jan 0001 00:00:00 +0000 /internal/index.html Purpose Define manual quality gates and release-readiness checks for DSAMbayes. The normal cadence is quarterly; these pages deliberately do not prescribe CI/CD. Audience Maintainers preparing and validating releases. Reviewers checking evidence before sign-off. Pages Page Topic Testing and Validation Quality-gate execution commands, expected outcomes, and evidence capture Quality Gates Gate definitions and pass/fail criteria Runner Smoke Tests Minimal runner validation runs Repository Size Cleanup Local repository-size findings and cleanup plan Release Readiness Checklist Gate checklist and sign-off fields Release Evidence Pack Artefact collection for stakeholder review Release Playbook Manual, evidence-led quarterly release process Sign-off Template Release sign-off record template