Logo

Getting started

This very simple case-study is designed to get you up-and-running quickly with statsmodels. Starting from raw data, we will show the steps needed to estimate a statistical model and to draw a diagnostic plot. We will only use functions provided by statsmodels or its pandas and patsy dependencies.

Loading modules and functions

After installing statsmodels and its dependencies, we load a few modules and functions:

In [1]: import statsmodels.api as sm
---------------------------------------------------------------------------
ImportError                               Traceback (most recent call last)
<ipython-input-1-6030a6549dc0> in <module>()
----> 1 import statsmodels.api as sm

/builddir/build/BUILD/statsmodels-0.6.1/statsmodels/api.py in <module>()
     13 from .discrete.discrete_model import (Poisson, Logit, Probit,
     14                                       MNLogit, NegativeBinomial)
---> 15 from .tsa import api as tsa
     16 from .duration.hazard_regression import PHReg
     17 from .nonparametric import api as nonparametric

/builddir/build/BUILD/statsmodels-0.6.1/statsmodels/tsa/api.py in <module>()
----> 1 from .ar_model import AR
      2 from .arima_model import ARMA, ARIMA
      3 from . import vector_ar as var
      4 from .arima_process import arma_generate_sample, ArmaProcess
      5 from .vector_ar.var_model import VAR

/builddir/build/BUILD/statsmodels-0.6.1/statsmodels/tsa/ar_model.py in <module>()
     14                                           cache_readonly, cache_writable)
     15 from statsmodels.tools.numdiff import approx_fprime, approx_hess
---> 16 from statsmodels.tsa.kalmanf.kalmanfilter import KalmanFilter
     17 import statsmodels.base.wrapper as wrap
     18 from statsmodels.tsa.vector_ar import util

/builddir/build/BUILD/statsmodels-0.6.1/statsmodels/tsa/kalmanf/__init__.py in <module>()
----> 1 from .kalmanfilter import KalmanFilter

/builddir/build/BUILD/statsmodels-0.6.1/statsmodels/tsa/kalmanf/kalmanfilter.py in <module>()
     31 from numpy.linalg import inv, pinv
     32 from statsmodels.tools.tools import chain_dot
---> 33 from . import kalman_loglike
     34 
     35 #Fast filtering and smoothing for multivariate state space models

ImportError: cannot import name kalman_loglike

In [2]: import pandas

In [3]: from patsy import dmatrices

pandas builds on numpy arrays to provide rich data structures and data analysis tools. The pandas.DataFrame function provides labelled arrays of (potentially heterogenous) data, similar to the R “data.frame”. The pandas.read_csv function can be used to convert a comma-separated values file to a DataFrame object.

patsy is a Python library for describing statistical models and building Design Matrices using R-like formulas.

Data

We download the Guerry dataset, a collection of historical data used in support of Andre-Michel Guerry’s 1833 Essay on the Moral Statistics of France. The data set is hosted online in comma-separated values format (CSV) by the Rdatasets repository. We could download the file locally and then load it using read_csv, but pandas takes care of all of this automatically for us:

In [4]: df = sm.datasets.get_rdataset("Guerry", "HistData").data
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-4-8e82bb04cf4f> in <module>()
----> 1 df = sm.datasets.get_rdataset("Guerry", "HistData").data

NameError: name 'sm' is not defined

The Input/Output doc page shows how to import from various other formats.

We select the variables of interest and look at the bottom 5 rows:

In [5]: vars = ['Department', 'Lottery', 'Literacy', 'Wealth', 'Region']

In [6]: df = df[vars]
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-6-97b909d2ba47> in <module>()
----> 1 df = df[vars]

NameError: name 'df' is not defined

In [7]: df[-5:]
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-7-387a2dedaa82> in <module>()
----> 1 df[-5:]

NameError: name 'df' is not defined

Notice that there is one missing observation in the Region column. We eliminate it using a DataFrame method provided by pandas:

In [8]: df = df.dropna()
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-8-c783d194b823> in <module>()
----> 1 df = df.dropna()

NameError: name 'df' is not defined

In [9]: df[-5:]
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-9-387a2dedaa82> in <module>()
----> 1 df[-5:]

NameError: name 'df' is not defined

Substantive motivation and model

We want to know whether literacy rates in the 86 French departments are associated with per capita wagers on the Royal Lottery in the 1820s. We need to control for the level of wealth in each department, and we also want to include a series of dummy variables on the right-hand side of our regression equation to control for unobserved heterogeneity due to regional effects. The model is estimated using ordinary least squares regression (OLS).

Design matrices (endog & exog)

To fit most of the models covered by statsmodels, you will need to create two design matrices. The first is a matrix of endogenous variable(s) (i.e. dependent, response, regressand, etc.). The second is a matrix of exogenous variable(s) (i.e. independent, predictor, regressor, etc.). The OLS coefficient estimates are calculated as usual:

System Message: WARNING/2 (\hat{\beta} = (X'X)^{-1} X'y)

latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2011/06/27> Babel <3.9k> and hyphenation patterns for 2 languages loaded. (/usr/share/texlive/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/share/texlive/texmf-dist/tex/latex/base/size12.clo)) (/usr/share/texlive/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.131 \endinput ^^M No pages of output. Transcript written on math.log.

where

System Message: WARNING/2 (y)

latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2011/06/27> Babel <3.9k> and hyphenation patterns for 2 languages loaded. (/usr/share/texlive/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/share/texlive/texmf-dist/tex/latex/base/size12.clo)) (/usr/share/texlive/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.131 \endinput ^^M No pages of output. Transcript written on math.log.
is an

System Message: WARNING/2 (N \times 1)

latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2011/06/27> Babel <3.9k> and hyphenation patterns for 2 languages loaded. (/usr/share/texlive/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/share/texlive/texmf-dist/tex/latex/base/size12.clo)) (/usr/share/texlive/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.131 \endinput ^^M No pages of output. Transcript written on math.log.
column of data on lottery wagers per capita (Lottery).

System Message: WARNING/2 (X)

latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2011/06/27> Babel <3.9k> and hyphenation patterns for 2 languages loaded. (/usr/share/texlive/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/share/texlive/texmf-dist/tex/latex/base/size12.clo)) (/usr/share/texlive/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.131 \endinput ^^M No pages of output. Transcript written on math.log.
is

System Message: WARNING/2 (N \times 7)

latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2011/06/27> Babel <3.9k> and hyphenation patterns for 2 languages loaded. (/usr/share/texlive/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/share/texlive/texmf-dist/tex/latex/base/size12.clo)) (/usr/share/texlive/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.131 \endinput ^^M No pages of output. Transcript written on math.log.
with an intercept, the Literacy and Wealth variables, and 4 region binary variables.

The patsy module provides a convenient function to prepare design matrices using R-like formulas. You can find more information here: http://patsy.readthedocs.org

We use patsy‘s dmatrices function to create design matrices:

In [10]: y, X = dmatrices('Lottery ~ Literacy + Wealth + Region', data=df, return_type='dataframe')
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-10-b205df6907aa> in <module>()
----> 1 y, X = dmatrices('Lottery ~ Literacy + Wealth + Region', data=df, return_type='dataframe')

NameError: name 'df' is not defined

The resulting matrices/data frames look like this:

In [11]: y[:3]
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-11-319cfe32a629> in <module>()
----> 1 y[:3]

NameError: name 'y' is not defined

In [12]: X[:3]
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-12-a0b703194835> in <module>()
----> 1 X[:3]

NameError: name 'X' is not defined

Notice that dmatrices has

  • split the categorical Region variable into a set of indicator variables.
  • added a constant to the exogenous regressors matrix.
  • returned pandas DataFrames instead of simple numpy arrays. This is useful because DataFrames allow statsmodels to carry-over meta-data (e.g. variable names) when reporting results.

The above behavior can of course be altered. See the patsy doc pages.

Model fit and summary

Fitting a model in statsmodels typically involves 3 easy steps:

  1. Use the model class to describe the model
  2. Fit the model using a class method
  3. Inspect the results using a summary method

For OLS, this is achieved by:

In [13]: mod = sm.OLS(y, X)    # Describe model
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-13-c6e56946df97> in <module>()
----> 1 mod = sm.OLS(y, X)    # Describe model

NameError: name 'sm' is not defined

In [14]: res = mod.fit()       # Fit model
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-14-6ff53364a7be> in <module>()
----> 1 res = mod.fit()       # Fit model

NameError: name 'mod' is not defined

In [15]: print res.summary()   # Summarize model
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-15-6ef19fe76b73> in <module>()
----> 1 print res.summary()   # Summarize model

NameError: name 'res' is not defined

The res object has many useful attributes. For example, we can extract parameter estimates and r-squared by typing:

In [16]: res.params
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-16-cdb8a4b8734e> in <module>()
----> 1 res.params

NameError: name 'res' is not defined

In [17]: res.rsquared
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-17-375327da2eb6> in <module>()
----> 1 res.rsquared

NameError: name 'res' is not defined

Type dir(res) for a full list of attributes.

For more information and examples, see the Regression doc page

Diagnostics and specification tests

statsmodels allows you to conduct a range of useful regression diagnostics and specification tests. For instance, apply the Rainbow test for linearity (the null hypothesis is that the relationship is properly modelled as linear):

In [18]: sm.stats.linear_rainbow(res)
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-18-d01346ddcfd4> in <module>()
----> 1 sm.stats.linear_rainbow(res)

NameError: name 'sm' is not defined

Admittedly, the output produced above is not very verbose, but we know from reading the docstring (also, print sm.stats.linear_rainbow.__doc__) that the first number is an F-statistic and that the second is the p-value.

statsmodels also provides graphics functions. For example, we can draw a plot of partial regression for a set of regressors by:

In [19]: sm.graphics.plot_partregress('Lottery', 'Wealth', ['Region', 'Literacy'],
   ....:                              data=df, obs_labels=False)
   ....: 
---------------------------------------------------------------------------
NameError                                 Traceback (most recent call last)
<ipython-input-19-e6a287f2a415> in <module>()
----> 1 sm.graphics.plot_partregress('Lottery', 'Wealth', ['Region', 'Literacy'],
      2                              data=df, obs_labels=False)

NameError: name 'sm' is not defined
_images/gettingstarted_0.png

More

Congratulations! You’re ready to move on to other topics in the Table of Contents