Skip to main content

Formula to model matrix converter

Project description

PyPI version Python versions License: MIT

wayne

logo

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)

logo

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 to x + 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_hp for wt*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.md triggers automatic PyPI releases
  • Testing: Run uv run -m pytest to run the test suite
  • Polynomial Validation: Run uv run compare_polynomials.py to 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wayne_trade-0.1.7.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wayne_trade-0.1.7-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file wayne_trade-0.1.7.tar.gz.

File metadata

  • Download URL: wayne_trade-0.1.7.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.19

File hashes

Hashes for wayne_trade-0.1.7.tar.gz
Algorithm Hash digest
SHA256 6445819762265f37603edbd9af2be078fc17eed4d6b2f630587255d5c062c718
MD5 57a1947a7a40f36e3733f87afeb291f9
BLAKE2b-256 698a70592e7dcdc805c9096e6a78f8bdf3bfff0e2a31ad02c091a9074463f0d5

See more details on using hashes here.

File details

Details for the file wayne_trade-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for wayne_trade-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 16fc24149570e3a06e2f0554bcca0f6244c7a4105b06605fcd8f2983b84b9905
MD5 8cccd7dacacfc436709e8666e220f919
BLAKE2b-256 665e7585917ca82a23e5dec53c21ab20547dddf2a4ef89a05af0e8f2a752ad08

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page