Tools and Features

Catalyst Analytics R: Feature-by-Feature Guide

Use every documented Catalyst Analytics R feature with sample input and expected output.

ProductCatalyst Analytics RVerified version1.2.0ComponentAccounting, Browser Demo Parity, Canonical JSON Export, Comparison, Data Intake, Dataset Validation, Derived Indicators, Indicator Registry, Package Validation, Reproducible Reports, Sensitivity, Snapshots, Source Metadata, Stress Testing, Uncertainty, WorkspacesUpdatedJuly 17, 2026Reading time18 minutes
← Back to product guides

Catalyst Analytics R · Technical Reference

Reproducible R data intake, metadata, validation, indicators, comparison, uncertainty, sensitivity, stress, accounting, workspaces, snapshots, reports, and export.

Audience: product users, administrators, reviewers, and integrators.

Last verified version: 1.2.0

Reading time: 18–30 minutes

Status: Published support documentation.

Purpose

This is the complete documented feature inventory for Catalyst Analytics R version 1.2.0. Every feature includes sample data, a seven-step use pattern, expected output, and a verification rule. Reverify this article whenever the product release changes.

Prerequisites

  • A clean demonstration workspace
  • The downloadable all-feature CSV or JSON
  • Current product release notes
  • Permission to use each tested feature
  • A reviewer familiar with the product

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.

Feature-by-feature procedure

1. Data Intake

Purpose: Use Data Intake within the governed Catalyst Analytics R workflow.

Sample action: read the feature-example CSV or JSON.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a governed R data object.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

2. Source Metadata

Purpose: Use Source Metadata within the governed Catalyst Analytics R workflow.

Sample action: attach publisher, URL, license, citation, retrieval, field, and unit metadata.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a source-aware dataset.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

3. Dataset Validation

Purpose: Use Dataset Validation within the governed Catalyst Analytics R workflow.

Sample action: check required fields, types, missingness, units, and duplicates.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a validation report.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

4. Indicator Registry

Purpose: Use Indicator Registry within the governed Catalyst Analytics R workflow.

Sample action: register annual energy savings.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a reusable indicator definition.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

5. Derived Indicators

Purpose: Use Derived Indicators within the governed Catalyst Analytics R workflow.

Sample action: calculate baseline minus retrofit kWh.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: derived values with method metadata.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

6. Comparison

Purpose: Use Comparison within the governed Catalyst Analytics R workflow.

Sample action: compare baseline and retrofit groups or periods.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a comparison table and effect summary.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

7. Uncertainty

Purpose: Use Uncertainty within the governed Catalyst Analytics R workflow.

Sample action: apply an explicit ±8% measurement range.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: intervals and assumptions.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

8. Sensitivity

Purpose: Use Sensitivity within the governed Catalyst Analytics R workflow.

Sample action: vary tariff and occupancy inputs.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a ranked sensitivity result.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

9. Stress Testing

Purpose: Use Stress Testing within the governed Catalyst Analytics R workflow.

Sample action: model 20% lower savings and 15% higher cost.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: stress-case outputs.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

10. Accounting

Purpose: Use Accounting within the governed Catalyst Analytics R workflow.

Sample action: reconcile monthly and annual energy totals.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a balance check.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

11. Workspaces

Purpose: Use Workspaces within the governed Catalyst Analytics R workflow.

Sample action: save data, indicators, assumptions, and outputs.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a persistent analytical state.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

12. Snapshots

Purpose: Use Snapshots within the governed Catalyst Analytics R workflow.

Sample action: freeze and restore complete workspace state.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a fingerprinted snapshot.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

13. Reproducible Reports

Purpose: Use Reproducible Reports within the governed Catalyst Analytics R workflow.

Sample action: render methods, figures, results, and limitations.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a rerunnable report.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

14. Canonical JSON Export

Purpose: Use Canonical JSON Export within the governed Catalyst Analytics R workflow.

Sample action: export the reviewed comparison.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a schema-versioned JSON record.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

15. Browser Demo Parity

Purpose: Use Browser Demo Parity within the governed Catalyst Analytics R workflow.

Sample action: repeat the conceptual workflow in the public demo.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a mapped result with parity limits.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

16. Package Validation

Purpose: Use Package Validation within the governed Catalyst Analytics R workflow.

Sample action: run tests, examples, documentation checks, and R CMD check.

Steps

  1. Open or create the synthetic retrofit workspace.
  2. Select or navigate to this feature.
  3. Enter the matching row from the CSV or JSON sample.
  4. Review required fields, sources, units, permissions, assumptions, and warnings.
  5. Run or save the feature operation.
  6. Compare the result with the expected result below.
  7. Add a review note and preserve the feature state.

Expected result: a release-validation report.

Verification: The result must preserve the sample feature ID, product version, lifecycle state, provenance, and any domain-specific unit or classification. Failure must return an actionable error without destroying prior state.

Expected output

  • a governed R data object
  • a source-aware dataset
  • a validation report
  • a reusable indicator definition
  • derived values with method metadata
  • a comparison table and effect summary
  • intervals and assumptions
  • a ranked sensitivity result
  • stress-case outputs
  • a balance check
  • a persistent analytical state
  • a fingerprinted snapshot
  • a rerunnable report
  • a schema-versioned JSON record
  • a mapped result with parity limits
  • a release-validation report

Whole-product verification

  • All 16 documented features are present or intentionally permission-restricted.
  • Every feature accepts its synthetic row or explains why it does not apply.
  • Errors preserve saved state and provide a recovery path.
  • Exports and handoffs retain provenance and version identity.
  • No private, confidential, or secret information appears in public output.

Responsible use

Statistical output requires method competence, source review, uncertainty communication, and domain interpretation; it is not automatic causal proof.

Scroll to Top