stats-transformer 1.2.0__tar.gz

stats_transformer-1.2.0/.gitignore

@@ -0,0 +1,253 @@
+# Byte-compiled / optimized / DLL files
+# Generated visualization outputs
+src/stats_transformer/visualization/expansion/
+# Generated dictionary mappings
+references/dictionaries/
+# Generated visualization configs
+references/viz/
+# Local archive of old project materials
+archive/
+# Generated/example review files
+src/examples/agent_reviews/
+# Notebook export outputs
+/data/notebook_exports/
+# DVC pipeline intermediates
+/data/pipeline/
+# Final processed data outputs
+/data/final/
+# Temporary working files
+/data/temp/
+# Immutable raw data (never modified)
+/data/raw/
+# Generated analysis reports and plots
+reports/
+# Archived/deprecated documentation (not tracked, preserved locally)
+docs/archive/
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Kilo
+#   Local Kilo configuration directory
+.kilo/
+
+# Agent workflow definitions
+#   Local Kilo/opencode agent specs; not part of the published package
+.agents/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Temp files
+src/temp/

stats_transformer-1.2.0/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.2.0] - 2026-06-16
+
+### Added
+- `ReportExporter` for markdown model cards, JSON run manifests, and markdown figure indexes.
+- Reporting exporter tests covering model-card rendering, manifest writing, and figure-index writing.
+
+## [1.1.0] - 2026-05-26
+
+### Added
+- `PanelBuilder` for panel data construction and validation workflows.
+- `PanelDiagnostics` helpers for regression diagnostics on panel model outputs.
+- `SpecRunner` for running reusable regression specifications.
+- `BaseIRF` foundation for impulse-response style time-series models.
+- `TableGenerator` and descriptive-statistics table helpers under `stats_transformer.visualization.tables`.
+- Updated heatmap behavior and bundled matplotlib styles for bar-chart and time-series visualizations.
+- Packaged example dataset registry with `list_examples()`, `describe_example()`, and `load_example()`.
+- Tests covering packaged example discovery, metadata, loading, and unknown-dataset errors.
+- `GrangerCausalityTester` for single-series and panel Granger causality tests under `stats_transformer.models.timeseries`.
+- Tests covering deterministic single-series and panel Granger causality workflows.
+- `TimeSeriesFeatureBuilder` for panel-safe lag, lead, and horizon feature construction.
+- `ForecastEvaluator` for MAE, MSE, RMSE, mean error, MAPE, and observation-count metrics.
+- `StationarityDiagnostics` for ADF and KPSS stationarity checks.
+- Time-series utility tests covering panel feature construction, forecast metrics, and stationarity diagnostics.
+
+### Changed
+- Updated README quickstart guidance to use installed-package imports and document packaged example loading.
+
+## [1.0.1] - 2026-05-26
+
+### Fixed
+- Fixed `Pipeline` constructor-driven model selection by reading `model_type` from stored keyword arguments.
+
+## [1.0.0] - 2026-05-12
+
+### Added
+- **Modular Visualization Framework**: Introduced a three-level architecture for highly reusable chart components.
+- **Standalone Chart Components**: 9 new atomic classes for standard econometric plots (`CoefficientBarChart`, `IRFPlot`, `BinnedScatterPlot`, etc.).
+- **Library-Bundled Aesthetics**: Built-in color palettes, significance stars, and matplotlib styles (`.mplstyle`) available within the package.
+- **Walkthrough Documentation**: New `07_visualization.ipynb` tutorial demonstrating the abstract component API.
+- **Enhanced Test Suite**: Comprehensive unit tests for all new visualization components.
+
+### Changed
+- **Refactored Visualizers**: `DataVisualizer` and `RegressionVisualizer` now delegate to the underlying `charts/` module while maintaining backward compatibility.
+- Updated `.gitignore` rules for more efficient tracking of academic datasets.
+
+
+- Initial release of stats-transformer.
+- Core `FeatureEngineer` for robust data transformation.
+- Core `RegressionModel` for standard and robust OLS.
+- Core `Pipeline` for YAML-driven execution.
+- Modular visualization tools (`DataVisualizer`, `ModelVisualizer`, `RegressionVisualizer`).
+- Comprehensive documentation and examples.

stats_transformer-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 corybaird
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

stats_transformer-1.2.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: stats-transformer
+Version: 1.2.0
+Summary: A comprehensive Python library for robust macroeconomic data transformation, analysis, and visualization.
+Project-URL: Homepage, https://github.com/corybaird/stats-transformer
+Project-URL: Repository, https://github.com/corybaird/stats-transformer
+Project-URL: Changelog, https://github.com/corybaird/stats-transformer/blob/main/CHANGELOG.md
+Author-email: Cory Baird <open.empirical.macro@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 corybaird
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: jupyter>=1.1.1
+Requires-Dist: linearmodels>=7.0
+Requires-Dist: matplotlib>=3.10.9
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: pyarrow>=19.0.0
+Requires-Dist: pyreadstat>=1.3.4
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: scikit-learn>=1.8.0
+Requires-Dist: seaborn>=0.13.2
+Requires-Dist: statsmodels>=0.14.6
+Description-Content-Type: text/markdown
+
+# stats-transformer
+
+`stats-transformer` is a Python library for macroeconomic data transformation, analysis, and visualization. Built around a configuration-driven architecture, it handles data ingestion, resampling, feature engineering, and econometric modeling for time-series and panel datasets.
+
+## Features
+
+- **Feature Engineering:** Advanced data transformations, frequency alignment, and robust merging capabilities for disparate datasets.
+- **Econometric Modeling:** Built-in support for standard OLS, Robust OLS, Panel Regression, IV regression, discrete choice, time-series models, and unsupervised learning models (PCA, KMeans).
+- **Visualization:** Automated generation of Exploratory Data Analysis (EDA) and regression model visual summaries (e.g., coefficient plots, residual plots, time-series tracking). Now includes a modular suite of standalone chart components for custom research plots.
+- **Configuration-Driven Orchestration:** Fully integrated with YAML configuration (`params.yaml`) to enable reproducible, stage-based execution compatible with DVC pipelines.
+
+## Quickstart
+
+### 1. Installation
+
+To use it in your project via PyPI:
+```bash
+uv add stats-transformer
+```
+
+For local development from this repository:
+
+```bash
+uv sync
+```
+
+### 2. Configuration (`params.yaml`)
+
+Define your data sources, pipeline parameters, and model specifications in a `params.yaml` file:
+
+```yaml
+data:
+  featurization:
+    entity_column: country
+  datasets:
+    - name: macro_data
+      path: data/raw/macro_indicators.csv
+      frequency: Q
+
+model:
+  model_type: panel_ols
+  target_variable: gdp_growth
+  independent_variables:
+    - interest_rate
+    - inflation
+
+visualization:
+  output_dir: reports/visualizations
+```
+
+### 3. Usage
+
+Load a packaged example dataset:
+
+```python
+from stats_transformer.data import list_examples, load_example
+
+print(list_examples())
+df = load_example("macrodb_gdp_inflation")
+```
+
+You can execute the pipeline via the command line using the `Pipeline` orchestrator:
+
+```bash
+# Run the full end-to-end pipeline
+uv run python -m stats_transformer.pipeline --config params.yaml
+```
+
+Or you can interact with the API programmatically:
+
+```python
+from stats_transformer import Pipeline
+
+# Initialize the pipeline with your configuration
+pipeline = Pipeline(params_path="params.yaml")
+
+# Run specific stages sequentially
+merged_data = pipeline.run(stage="resample")
+transformed_data = pipeline.run(stage="features")
+model_results = pipeline.run(stage="regression")
+
+# Generate and save visualizations
+pipeline.run(stage="visualization")
+```
+
+### 4. Testing
+
+Verify the installation and library integrity by running the test suite:
+
+```bash
+uv run pytest tests
+```
+
+For more details on test coverage, see the [Testing Suite](docs/validation/testing_suite.md).
+
+## Documentation
+
+- **Examples:** For examples of running the models, see [docs/validation/academic_examples.md](docs/validation/academic_examples.md).
+- **Visualization Walkthrough:** For a guide on using the modular chart components, see [notebooks/07_chart_components.ipynb](notebooks/07_chart_components.ipynb).
+- **System Design:** For more details on the system design, see [docs/library/architecture.md](docs/library/architecture.md).
+- **File Structure:** For the standardized research folder structure, see [docs/library/file_structure.md](docs/library/file_structure.md).
+- **Validation & Testing:** For details on the testing suite, see [docs/validation/testing_suite.md](docs/validation/testing_suite.md).

stats_transformer-1.2.0/README.md

@@ -0,0 +1,102 @@
+# stats-transformer
+
+`stats-transformer` is a Python library for macroeconomic data transformation, analysis, and visualization. Built around a configuration-driven architecture, it handles data ingestion, resampling, feature engineering, and econometric modeling for time-series and panel datasets.
+
+## Features
+
+- **Feature Engineering:** Advanced data transformations, frequency alignment, and robust merging capabilities for disparate datasets.
+- **Econometric Modeling:** Built-in support for standard OLS, Robust OLS, Panel Regression, IV regression, discrete choice, time-series models, and unsupervised learning models (PCA, KMeans).
+- **Visualization:** Automated generation of Exploratory Data Analysis (EDA) and regression model visual summaries (e.g., coefficient plots, residual plots, time-series tracking). Now includes a modular suite of standalone chart components for custom research plots.
+- **Configuration-Driven Orchestration:** Fully integrated with YAML configuration (`params.yaml`) to enable reproducible, stage-based execution compatible with DVC pipelines.
+
+## Quickstart
+
+### 1. Installation
+
+To use it in your project via PyPI:
+```bash
+uv add stats-transformer
+```
+
+For local development from this repository:
+
+```bash
+uv sync
+```
+
+### 2. Configuration (`params.yaml`)
+
+Define your data sources, pipeline parameters, and model specifications in a `params.yaml` file:
+
+```yaml
+data:
+  featurization:
+    entity_column: country
+  datasets:
+    - name: macro_data
+      path: data/raw/macro_indicators.csv
+      frequency: Q
+
+model:
+  model_type: panel_ols
+  target_variable: gdp_growth
+  independent_variables:
+    - interest_rate
+    - inflation
+
+visualization:
+  output_dir: reports/visualizations
+```
+
+### 3. Usage
+
+Load a packaged example dataset:
+
+```python
+from stats_transformer.data import list_examples, load_example
+
+print(list_examples())
+df = load_example("macrodb_gdp_inflation")
+```
+
+You can execute the pipeline via the command line using the `Pipeline` orchestrator:
+
+```bash
+# Run the full end-to-end pipeline
+uv run python -m stats_transformer.pipeline --config params.yaml
+```
+
+Or you can interact with the API programmatically:
+
+```python
+from stats_transformer import Pipeline
+
+# Initialize the pipeline with your configuration
+pipeline = Pipeline(params_path="params.yaml")
+
+# Run specific stages sequentially
+merged_data = pipeline.run(stage="resample")
+transformed_data = pipeline.run(stage="features")
+model_results = pipeline.run(stage="regression")
+
+# Generate and save visualizations
+pipeline.run(stage="visualization")
+```
+
+### 4. Testing
+
+Verify the installation and library integrity by running the test suite:
+
+```bash
+uv run pytest tests
+```
+
+For more details on test coverage, see the [Testing Suite](docs/validation/testing_suite.md).
+
+## Documentation
+
+- **Examples:** For examples of running the models, see [docs/validation/academic_examples.md](docs/validation/academic_examples.md).
+- **Visualization Walkthrough:** For a guide on using the modular chart components, see [notebooks/07_chart_components.ipynb](notebooks/07_chart_components.ipynb).
+- **System Design:** For more details on the system design, see [docs/library/architecture.md](docs/library/architecture.md).
+- **File Structure:** For the standardized research folder structure, see [docs/library/file_structure.md](docs/library/file_structure.md).
+- **Validation & Testing:** For details on the testing suite, see [docs/validation/testing_suite.md](docs/validation/testing_suite.md).

stats_transformer-1.2.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "stats-transformer"
+version = "1.2.0"
+description = "A comprehensive Python library for robust macroeconomic data transformation, analysis, and visualization."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.12"
+authors = [
+  { name="Cory Baird", email="open.empirical.macro@gmail.com" }
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "jupyter>=1.1.1",
+    "linearmodels>=7.0",
+    "matplotlib>=3.10.9",
+    "pandas>=2.2.3",
+    "pyarrow>=19.0.0",
+    "pyreadstat>=1.3.4",
+    "pyyaml>=6.0.3",
+    "scikit-learn>=1.8.0",
+    "seaborn>=0.13.2",
+    "statsmodels>=0.14.6",
+]
+
+[project.urls]
+Homepage = "https://github.com/corybaird/stats-transformer"
+Repository = "https://github.com/corybaird/stats-transformer"
+Changelog = "https://github.com/corybaird/stats-transformer/blob/main/CHANGELOG.md"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+[dependency-groups]
+dev = [
+    "pytest>=9.0.3",
+]
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+  "/.github",
+  "/.agents",
+  "/data",
+  "/docs",
+  "/notebooks",
+  "/references",
+  "/tests",
+  "/reports",
+  "/models",
+]