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

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

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_x_hp for wt*hp)
  • Polynomial terms: Orthogonal polynomial columns (e.g., poly_disp_1, poly_disp_2, etc.)
  • 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.4.tar.gz (8.3 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.4-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wayne_trade-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f8a95785247dfdf2f576d55ee014bf6a890bf351940ff40c8a6deb37d0c68457
MD5 64fc3272be292de328990d11ee4786fe
BLAKE2b-256 e846c48f7c7b2ada46b1377db036743ddb6b03c5fdfce417d7df141f9ba7e5a3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wayne_trade-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 458ab36cba3bebc3ba0890ee543936ce9100151ed0777972af5a08d167ca32d9
MD5 06cb5ae89a4293c7bd8f6bf80f5f411b
BLAKE2b-256 999882e570930773ce60f1920c33c32ab12164eaa899a928097642c25dc63414

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