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

Filename

Total

Covered

Missing

Coverage in %

📦r2x_core

0

0

0

-100.0%

 📦r2x_core

2

2

0

100.0%

  📦units

5

5

0

100.0%

     _mixins

9

9

0

100.0%

     _specs

8

8

0

100.0%

     _utils

7

7

0

100.0%

  📦utils

1

1

0

100.0%

     export

4

4

0

100.0%

     files

7

7

0

100.0%

     iteration

2

2

0

100.0%

     overrides

3

3

0

100.0%

     parser

2

2

0

100.0%

     rules

12

12

0

100.0%

     upgrade

12

12

0

100.0%

     validation

6

6

0

100.0%

     version

3

3

0

100.0%

    datafile

12

12

0

100.0%

    exceptions

12

12

0

100.0%

    file_readers

6

6

0

100.0%

    file_types

9

9

0

100.0%

    getters

5

5

0

100.0%

    h5_readers

10

10

0

100.0%

    logger

10

10

0

100.0%

    plugin_base

14

14

0

100.0%

    plugin_config

12

12

0

100.0%

    plugin_context

9

9

0

100.0%

    plugin_expose

2

2

0

100.0%

    processors

27

27

0

100.0%

    provenance

14

14

0

100.0%

    reader

6

6

0

100.0%

    result

7

7

0

100.0%

    rules

21

21

0

100.0%

    rules_executor

15

15

0

100.0%

    store

21

21

0

100.0%

    system

14

14

0

100.0%

    time_series

13

13

0

100.0%

    types

1

1

0

100.0%

    versioning

10

10

0

100.0%

Overall (38 files):

2

2

0

100.0%

Legend

%

Coverage Level

≤0%

No documentation

≤25%

Minimal documentation

≤50%

Some documentation

≤75%

Good documentation

≤100%

Complete documentation