πŸ“Š API OverviewΒΆ

This document provides an overview of the API documentation for the owlmix package, focusing on the main analytical, plotting, utility, and typing modules.

Modules CoveredΒΆ

  • analysis/: Analytical methods and statistical tools for EDA.

  • plotter/: Plotting utilities for visualizing analysis results.

  • utils/: Utility functions for file operations and support tasks.

  • typing.rst: Type definitions and conventions.

Analysis ModulesΒΆ

The analysis subpackage provides core analytical tools for exploratory data analysis:

  • ACF/PACF: Autocorrelation and partial autocorrelation analysis.

  • Box Plot: Box plot statistics and visualization.

  • Causality: Methods for causal inference and analysis.

  • Correlation: Correlation metrics and computation.

  • VIF: Variance Inflation Factor (VIF) analysis for multicollinearity.

Each module documents the main classes, functions, and usage examples for its respective analysis.

Plotter ModulesΒΆ

The plotter subpackage contains plotting utilities for visualizing the results of analytical methods:

  • ACF/PACF: Plotting autocorrelation and partial autocorrelation functions.

  • Box Plot: Generating box plots for data distributions.

  • Correlation: Visualizing correlation matrices and relationships.

  • VIF: Plotting VIF results for feature selection.

These modules describe the plotting APIs, input requirements, and customization options.

Utility ModulesΒΆ

The utils subpackage provides supporting utilities:

  • File Resolver: Functions for resolving file paths and managing file I/O.

Directory StructureΒΆ

  • analysis/: Analytical methods and statistics.

  • plotter/: Plotting and visualization utilities.

  • utils/: Supporting utility functions.

ExtensibilityΒΆ

The API is designed to be modular and extensible. New analytical or plotting modules can be added as needed, and utility functions can be extended to support additional workflows.

SummaryΒΆ

The API documentation provides detailed reference material for the analytical, plotting, and utility components of the owlmix package, supporting robust and extensible exploratory data analysis workflows.

Back to Home