Skip to main content

Diagnostic Plots for Lineare Regression Models. Similar to plot.lm in R.

Project description

Python Library providing Diagnostic Plots for Lineare Regression Models. (Like plot.lm in R.)

I built this, because I missed the diagnostics plots of R for a university project. There are some substitutions in Python for individual charts, but they are spread over different libraries and sometimes don’t show the exact same. My implementation tries to copycat the R-plots, but I didn’t reimplement the R-code: The charts are just based on available documentation.

Installation

Available in PyPi: https://pypi.org/project/lmdiag/

  • Using pip: pip install lmdiag

  • Using pipenv: pipenv install lmdiag

Usage

The plots need a fitted Linear Regression Model created by statsmodels as input.

Example

(See also the more extensive Example Notebook)

import numpy as np
import matplotlib.pyplot as plt
import statsmodels.api as sm
import lmdiag

%matplotlib inline  # In Jupyter

# Generate sample model
np.random.seed(20)
predictor = np.random.normal(size=30, loc=20, scale=3)
response = 5 + 5 * predictor + np.random.normal(size=30)
X = sm.add_constant(predictor)
lm = sm.OLS(response, X).fit()

# Plot chart matrix (and enlarge figure)
plt.figure(figsize=(10,7))
lmdiag.plot(lm);
https://raw.githubusercontent.com/dynobo/lmdiag/master/example.png

Methods

  • Draw matrix of all plots:

    lmdiag.plot(lm)

  • Draw individual plots:

    lmdiag.resid_fit(lm)

    lmdiag.q_q(lm)

    lmdiag.scale_loc(lm)

    lmdiag.resid_lev(lm)

  • Print useful descriptions for interpretations:

    lmdiag.info() (for all plots)

    lmdiag.info('<method name>') (for individual plot)

Development

Disclaimer

This is my very first public python library. Don’t expect everything to work smoothly. I’m happy to receive useful feedback or pull requests.

Certification

https://raw.githubusercontent.com/dynobo/lmdiag/master/badge.png

Packaging and Upload to PyPi

  • pipenv run rstcheck README.rst (check syntax)

  • rm -rf ./dist (delete old builds)

  • python setup.py sdist

  • python setup.py bdist_wheel

  • twine upload dist/*

  • Then new release on github…

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

lmdiag-0.1.666666.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

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

lmdiag-0.1.666666-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file lmdiag-0.1.666666.tar.gz.

File metadata

  • Download URL: lmdiag-0.1.666666.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for lmdiag-0.1.666666.tar.gz
Algorithm Hash digest
SHA256 8ddd7a97756185d8f98670550818425cff8c8d0676e6ab38e2140b4d36744127
MD5 c4f008198a60b2340d7b8a751f0a5314
BLAKE2b-256 fcbebaec5eed42c82556884b9ecb368dd94b13fbc0947eec0cb52c8686f8ae66

See more details on using hashes here.

File details

Details for the file lmdiag-0.1.666666-py3-none-any.whl.

File metadata

File hashes

Hashes for lmdiag-0.1.666666-py3-none-any.whl
Algorithm Hash digest
SHA256 e0e44d7ac021aa257f6c8581ccff9476268696a5b8dda2122e84ba71e63bf741
MD5 af6b58293b1f7a89f23b2df5ab3a815e
BLAKE2b-256 c3187d3f1ee1831199d289d3154df460afbcadc905a8f02051ae6c2d81aadc1e

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