Metadata-Version: 2.1
Name: marginaleffects
Version: 0.0.7
Summary: 
Author: Vincent Arel-Bundock
Author-email: vincent.arel-bundock@umontreal.ca
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: numpy (>=1.25.0,<2.0.0)
Requires-Dist: patsy (>0.5.0)
Requires-Dist: plotnine (>0.12.3)
Requires-Dist: polars (>0.20.1)
Requires-Dist: pyarrow (>=14.0.1,<15.0.0)
Requires-Dist: scipy (>=1.10.0,<2.0.0)
Description-Content-Type: text/markdown

The parameters of a statistical model can sometimes be difficult to interpret substantively, especially when that model includes non-linear components, interactions, or transformations. Analysts who fit such complex models often seek to transform raw parameter estimates into quantities that are easier for domain experts and stakeholders to understand, such as predictions, contrasts, risk differences, ratios, odds, lift, slopes, and so on.

Unfortunately, computing these quantities---along with associated standard errors---can be a tedious and error-prone task. This problem is compounded by the fact that modeling packages in `R` and `Python` produce objects with varied structures, which hold different information. This means that end-users often have to write customized code to interpret the estimates obtained by fitting Linear, GLM, GAM, Bayesian, Mixed Effects, and other model types. This can lead to wasted effort, confusion, and mistakes, and it can hinder the implementation of best practices.

## Marginal Effects Zoo: The Book

[This free online book ](https://marginaleffects.com/) introduces a conceptual framework to clearly define statistical quantities of interest, and shows how to estimate those quantities using the `marginaleffects` package for `R` and `Python`. The techniques introduced herein can enhance the interpretability of [over 100 classes of statistical and machine learning models](https://marginaleffects.com/vignettes/supported_models.html), including linear, GLM, GAM, mixed-effects, bayesian, categorical outcomes, XGBoost, and more. With a single unified interface, users can compute and plot many estimands, including:

* Predictions (aka fitted values or adjusted predictions)
* Comparisons such as contrasts, risk differences, risk ratios, odds, etc.
* Slopes (aka marginal effects or partial derivatives) 
* Marginal means
* Linear and non-linear hypothesis tests
* Equivalence tests
* Uncertainty estimates using the delta method, bootstrapping, simulation, or conformal inference.
* Much more!

[The Marginal Effects Zoo](https://marginaleffects.com/) book includes over 30 chapters of tutorials, case studies, and technical notes. It covers a wide range of topics, including how the `marginaleffects` package can facilitate the analysis of:

* Experiments
* Observational data
* Causal inference with G-Computation
* Machine learning models
* Bayesian modeling
* Multilevel regression with post-stratification (MRP)
* Missing data
* Matching
* Inverse probability weighting
* Conformal prediction

[Get started by clicking here!](https://marginaleffects.com/vignettes/get_started.html)

## How to help

The `marginaleffects` package and the Marginal Effects Zoo book will always be free. If you like this project, you can contribute in four ways:

1. Make a donation to the [Native Women's Shelter of Montreal](https://www.nwsm.info/) or to [Give Directly](https://www.givedirectly.org/), and send me (Vincent) a quick note. You'll make my day.
2. Submit bug reports, documentation improvements, or code contributions to the Github repositories of the [R version](https://github.com/vincentarelbundock/marginaleffects) or the [Python version](https://github.com/vincentarelbundock/pymarginaleffects) of the package.
3. [Cite the `marginaleffects` package](https://marginaleffects.com/CITATION.html) in your work and tell your friends about it.
4. Create a new entry [for the Meme Gallery!](https://marginaleffects.com/vignettes/meme.html)


<div align="center">
<a href="https://marginaleffects.com">
    <img src="https://user-images.githubusercontent.com/987057/134899484-e3392510-2e94-4c39-9830-53356fa5feed.png" align="center" alt="marginaleffects logo" width="200" />
</a>
<br><br>
<img src="https://github.com/vincentarelbundock/marginaleffects/workflows/R-CMD-check/badge.svg">
<img src="https://img.shields.io/badge/license-GPLv3-blue">
<a href = "https://marginaleffects.com" target = "_blank"><img src="https://img.shields.io/static/v1?label=Website&message=Visit&color=blue"></a>
<br><br>
</div>
