Technical Reference
Catalyst Analytics R: Technical Reference and Integrations
Review the technical, data, lifecycle, validation, and integration contract for Catalyst Analytics R.
Catalyst Analytics R · Technical Reference
Reproducible R data intake, metadata, validation, indicators, comparison, uncertainty, sensitivity, stress, accounting, workspaces, snapshots, reports, and export.
Purpose
This reference summarizes the functional contract, record expectations, lifecycle, validation, export, compatibility, integration, privacy, and release-review requirements for Catalyst Analytics R.
Prerequisites
- Current release notes and repository documentation
- A test environment
- A backup and rollback plan
- Access to product health or package checks
- The synthetic all-feature sample
Sample data
This article uses a fictional Resilient Community Retrofit Program. The files contain one demonstration row for every documented feature, so each capability can be tested without private or production data.
Download CSV feature examples · Download JSON workspace example
Preview
| # | Feature | Sample action | Expected result | Classification |
|---|---|---|---|---|
| 1 | Data Intake | read the feature-example CSV or JSON | a governed R data object | synthetic-demo |
| 2 | Source Metadata | attach publisher, URL, license, citation, retrieval, field, and unit metadata | a source-aware dataset | synthetic-demo |
| 3 | Dataset Validation | check required fields, types, missingness, units, and duplicates | a validation report | synthetic-demo |
| 4 | Indicator Registry | register annual energy savings | a reusable indicator definition | synthetic-demo |
| 5 | Derived Indicators | calculate baseline minus retrofit kWh | derived values with method metadata | synthetic-demo |
The downloadable files include all 16 feature rows.
Technical contract
Canonical identity
| Field | Value |
|---|---|
| Product slug | catalyst-analytics-r |
| Product name | Catalyst Analytics R |
| Verified version | 1.2.0 |
| Content pack | 1.0.0 |
| Default article state | draft |
| Human review | required |
Functional surface
| Capability | Sample operation | Expected artifact |
|---|---|---|
| Data Intake | read the feature-example CSV or JSON | a governed R data object |
| Source Metadata | attach publisher, URL, license, citation, retrieval, field, and unit metadata | a source-aware dataset |
| Dataset Validation | check required fields, types, missingness, units, and duplicates | a validation report |
| Indicator Registry | register annual energy savings | a reusable indicator definition |
| Derived Indicators | calculate baseline minus retrofit kWh | derived values with method metadata |
| Comparison | compare baseline and retrofit groups or periods | a comparison table and effect summary |
| Uncertainty | apply an explicit ±8% measurement range | intervals and assumptions |
| Sensitivity | vary tariff and occupancy inputs | a ranked sensitivity result |
| Stress Testing | model 20% lower savings and 15% higher cost | stress-case outputs |
| Accounting | reconcile monthly and annual energy totals | a balance check |
| Workspaces | save data, indicators, assumptions, and outputs | a persistent analytical state |
| Snapshots | freeze and restore complete workspace state | a fingerprinted snapshot |
| Reproducible Reports | render methods, figures, results, and limitations | a rerunnable report |
| Canonical JSON Export | export the reviewed comparison | a schema-versioned JSON record |
| Browser Demo Parity | repeat the conceptual workflow in the public demo | a mapped result with parity limits |
| Package Validation | run tests, examples, documentation checks, and R CMD check | a release-validation report |
Core record fields
- Stable record or artifact ID
- Product and schema version
- Created and updated time
- Owner or responsible role
- Lifecycle or review state
- Source and provenance
- Units, period, geography, classification, or audience where applicable
- Validation findings and uncertainty
- Privacy and publication boundary
- Export or handoff integrity metadata
Lifecycle
Use a human-controlled lifecycle such as draft → review → approved/published, with revise, superseded, archived, withdrawn, failed, and recovered states where appropriate. Automated analysis may recommend; it must not silently approve, publish, or create private cases.
Validation
- Required-field and type checks
- Identifier and relationship checks
- Unit, period, geography, method, and classification compatibility
- Product and schema compatibility
- Source, evidence, and provenance completeness
- Permission, privacy, and publication-boundary checks
- Deterministic checksum or fingerprint validation for portable artifacts
Integrations
- Catalyst Data
- Decision Studio
- Research Lab
- Workbench
- Knowledge Library
Send the minimum required fields through a typed contract. Preserve source product, destination, schema, artifact ID, review state, provenance, consent or privacy boundary, and receipt. Private Contact and Engagement records never belong in public support or research artifacts.
Release review
- Confirm interface, service, manifest, package, and schema versions.
- Validate the all-feature sample.
- Run product tests and integrity checks.
- Test one export and each supported handoff category.
- Document breaking changes and migration path.
- Update Last Verified Version before publishing this article.
Expected output
- A complete feature contract
- A validated synthetic export
- A compatibility decision
- A documented integration receipt
- A release-integrity report
Verification
- Product slug, version, schema, and IDs agree.
- Every documented feature maps to an actual interface, command, route, or record.
- The sample files produce the stated artifacts.
- Integrations preserve provenance and privacy.
- Migration, rollback, support, and release documentation are current.
Responsible use
Statistical output requires method competence, source review, uncertainty communication, and domain interpretation; it is not automatic causal proof.