Formula to model matrix converter
Project description
wayne
trade a formula to model matrix
"Greet each day with a smile, so it doesn't know what you're planning on doing to it." - Wayne
Formula to Model Matrix in One Function Call
wyane is a Python package that converts statistical formulas into model matrices using Polars DataFrames. It does one thing: takes a formula and a DataFrame, returns a model matrix.
Installation
Requirements: Python 3.13+ (due to fiasto-py dependency)
uv pip install wayne-trade
# or
pip install wayne-trade
Usage
import wayne
import polars as pl
# Load your data
df = pl.read_csv("data/mtcars.csv")
# Define your formula
formula = 'mpg ~ cyl + wt*hp + poly(disp, 4) - 1'
# Get the model matrix
model_matrix = wayne.trade_formula_for_matrix(df, formula)
print(model_matrix)
Wayne Speak Fiasto
Wayne provides a clean interface to fiasto-py's parsing functionality without requiring users to directly import fiasto-py and deal with its maturin/pyo3 complexity:
import wayne
# Parse a formula to get detailed structure
result = wayne.speak_fiasto("mpg ~ cyl + wt*hp + poly(disp, 4) - 1")
print(result['columns'].keys()) # All variables and their metadata
print(result['metadata']['has_intercept']) # Formula metadata
print(result['all_generated_columns']) # All generated column names
Features
- Single Function:
trade_formula_for_matrix(df, formula) - Polars Integration: Works with Polars DataFrames
- R-Style Formulas: Supports R/Wilkinson notation
- Fast Parsing: Rust + fiasto for formula parsing
- Orthogonal Polynomials: NumPy-based polynomial generation
- Interactions: Handles interaction terms (e.g.,
x*z) - Intercept Control: Add/remove intercept with
+1/-1
Formula Syntax
Wayne supports R-style statistical formulas:
- Basic terms:
y ~ x + z - Interactions:
y ~ x*z(expands tox + z + x:z) - Polynomial terms:
y ~ poly(x, 3)(generates 3 orthogonal polynomial columns) - Intercept control:
y ~ x - 1(removes intercept) - Complex formulas:
y ~ x + z + poly(w, 3) + x:z - 1
Examples
See the examples/ directory for complete examples:
# Main example
uv run python examples/final_example.py
# Single function demo
uv run python examples/single_function_example.py
What You Get
The model matrix contains:
- Main effects: Original variables from your formula
- Interaction terms: Generated interaction columns (e.g.,
wt_hpforwt*hp) - Polynomial terms: Orthogonal polynomial columns (e.g.,
disp_poly_1,disp_poly_2, etc.)
Development & Releases
For developers and maintainers:
- Release Process: See RELEASE.md for how to release new versions to PyPI
- Automatic Releases: Pushing changes to
CHANGELOG.mdtriggers automatic PyPI releases - Testing: Run
uv run -m pytestto run the test suite - Polynomial Validation: Run
uv run compare_polynomials.pyto verify R compatibility - Intercept: Optional intercept column
Perfect for Statistical Modeling
Wayne creates model matrices that are ready for:
- Linear regression
- Generalized linear models
- Mixed effects models
- Any statistical modeling that needs a design matrix
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wayne_trade-0.1.6.tar.gz.
File metadata
- Download URL: wayne_trade-0.1.6.tar.gz
- Upload date:
- Size: 10.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
943f10fa1fbcc1915713c3abdc580a35ca35a1b182740c98d6e9c2acb7a53858
|
|
| MD5 |
01e0364053a0ae2ca21e1bb35e0200db
|
|
| BLAKE2b-256 |
31be055de1c5dafb12225e8cc043fd6e9373a1f4361fc925f9533e3324422c87
|
File details
Details for the file wayne_trade-0.1.6-py3-none-any.whl.
File metadata
- Download URL: wayne_trade-0.1.6-py3-none-any.whl
- Upload date:
- Size: 6.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2c5ad39f8a2a60a54fad344ceabbb87756f2112253a7759db70c16dbbeac228c
|
|
| MD5 |
3ff72ca7b6b5d9400c55df38e9434bb6
|
|
| BLAKE2b-256 |
7f89fc6a03f4c971a3b8212c85517e7819af02164f79990e1840b639efcb790c
|