Reference

r2x-core provides data file management, plugin configuration, and system management classes:

Core Classes¶

• System - Core system container

• DataStore - Data file storage

• DataReader - Data reading utility

• DataFile - Data file configuration

• FileInfo - Data file metadata

• ReaderConfig - File reader configuration

• TabularProcessing - Tabular processing pipeline

• JSONProcessing - JSON processing pipeline

• PluginConfig - Plugin configuration

• Plugin - Plugin base class

• PluginContext - Plugin execution context

• FileFormat - File format enum

• H5Format - HDF5 file format enum

Rules and Translation¶

• Rule - Rule definition and validation

• RuleFilter - Component filtering predicates

• RuleResult - Per-rule results

• TranslationResult - Translation result summary

• apply_rules_to_context() - Execute all rules in a context

• apply_single_rule() - Apply one rule to components

Utilities¶

• components_to_records() - Export components as records

• export_components_to_csv() - Export components to CSV

• create_component() - Create and validate components

• getter() - Register getter functions

• transfer_time_series_metadata() - Transfer time series metadata

Versioning and Upgrades¶

• VersionStrategy - Versioning protocol base class

• SemanticVersioningStrategy - Semantic versioning

• GitVersioningStrategy - Git-based versioning

• UpgradeStep - Upgrade step definition

• UpgradeType - Upgrade type enum

• run_upgrade_step() - Execute a single upgrade step

• VersionReader - Version detection utility

For detailed API documentation with examples and method signatures, see the Complete API Documentation.

Documentation Coverage¶

Docstring coverage is checked separately with mise run docstrings.