API Reference

This section provides detailed documentation for all public modules, classes, and functions in the Macrodata Refinement (MDR) package.

Core Components

• Refinement
  • RefinementConfig
  • smooth_data()
  • remove_outliers()
  • impute_missing_values()
  • refine_data()
  • apply_refinement_pipeline()
  • Overview
  • Core Components
  • Usage Examples
• Validation
  • ValidationResult
  • check_data_range()
  • check_missing_values()
  • check_outliers()
  • check_data_integrity()
  • validate_data()
  • Overview
  • Core Components
  • Usage Examples
• Transformation
  • NormalizationType
  • normalize_data()
  • scale_data()
  • apply_logarithmic_transform()
  • apply_power_transform()
  • apply_rolling_window()
  • transform_data()
  • Overview
  • Core Functions
  • Available Transformations
  • Usage Examples

Input/Output Components

• Data Readers
  • DataSource
  • DataReader
  • FileReader
  • CSVReader
  • JSONReader
  • ExcelReader
  • ParquetReader
  • HDF5Reader
  • get_reader()
  • read_csv()
  • read_json()
  • read_excel()
  • read_parquet()
  • read_hdf5()
  • Overview
  • Supported File Formats
  • Core Functions
  • Usage Examples
• Data Writers
  • DataDestination
  • DataWriter
  • FileWriter
  • CSVWriter
  • JSONWriter
  • ExcelWriter
  • ParquetWriter
  • HDF5Writer
  • get_writer()
  • write_csv()
  • write_json()
  • write_excel()
  • write_parquet()
  • write_hdf5()
  • Overview
  • Supported File Formats
  • Core Functions
  • Usage Examples
• Data Formats
  • FormatType
  • detect_format()
  • validate_format()
  • convert_format()
  • convert_file_format()
  • infer_column_types()
  • cast_column_types()
  • is_numeric_column()
  • try_common_datetime_formats()
  • is_datetime_column()
  • Overview
  • Core Functions
  • Supported Formats
  • Usage Examples

Visualization Components

• Data Visualization
  • PlotConfig
  • plot_time_series()
  • plot_histogram()
  • plot_boxplot()
  • plot_heatmap()
  • plot_scatter()
  • plot_correlation_matrix()
  • plot_validation_results()
  • plot_refinement_comparison()
  • save_plot()
  • Overview
  • Plot Types
  • Core Functions
  • Input Format Compatibility
  • Customization Options
  • Usage Examples

API Components

• Command-Line Interface
  • CLICommand
  • CommandRegistry
  • create_cli()
  • parse_args()
  • run_command()
  • refine_command()
  • validate_command()
  • convert_command()
  • main()
  • Overview
  • Commands
  • CLI Usage
  • Command Reference
  • Advanced Usage
• REST API
  • HTTPMethod
  • ResponseFormat
  • APIConfig
  • APIResponse
  • MDRRequestHandler
  • register_route()
  • start_server()
  • stop_server()
  • refine_data_endpoint()
  • validate_data_endpoint()
  • Overview
  • API Endpoints
  • Server Configuration
  • Core Endpoint Functions
  • Running the API Server
  • Docker Deployment
  • API Usage Examples

Utility Components

• Helper Utilities
  • validate_numeric_array()
  • validate_range()
  • moving_average()
  • detect_seasonality()
  • interpolate_missing()
  • flatten_dict()
  • unflatten_dict()
  • get_memory_usage()
  • Overview
  • Core Functions
  • Usage Examples
• Logging Utilities
  • LogLevel
  • LogHandler
  • setup_logger()
  • get_logger()
  • set_log_level()
  • log_execution_time()
  • Overview
  • Core Components
  • Functions
  • Usage Examples
  • Advanced Configuration