|
1 | 1 | Overview |
2 | 2 | ======== |
3 | 3 |
|
4 | | - *"It's only a model."* -- `Patsy <https://en.wikipedia.org/wiki/Patsy_%28Monty_Python%29>`_ |
5 | | - |
6 | | -:mod:`patsy` is a Python package for describing statistical models |
7 | | -and building design matrices. It is closely inspired by the 'formula' |
8 | | -mini-language used in `R <http://www.r-project.org/>`_ and `S |
9 | | -<https://secure.wikimedia.org/wikipedia/en/wiki/S_programming_language>`_. The |
10 | | -name is in honor of `Val Patsy |
11 | | -<http://www.wimbledon.arts.ac.uk/35174.htm>`_, who `built models |
12 | | -<http://www.imdb.com/name/nm0153313/>`_ for Monty Python. |
13 | | - |
14 | | -For instance, if we have some variable ``y``, and we want to regress it |
15 | | -against some other variables ``x``, ``a``, ``b``, and the `interaction |
| 4 | + |epigraph|_ |
| 5 | + |
| 6 | + .. |epigraph| replace:: *"It's only a model."* |
| 7 | + |
| 8 | + .. _epigraph: https://en.wikipedia.org/wiki/Patsy_%28Monty_Python%29 |
| 9 | + |
| 10 | +:mod:`patsy` is a Python package for describing statistical models and |
| 11 | +building design matrices. It is closely inspired by and compatible |
| 12 | +with the 'formula' mini-language used in `R |
| 13 | +<http://www.r-project.org/>`_ and `S |
| 14 | +<https://secure.wikimedia.org/wikipedia/en/wiki/S_programming_language>`_. |
| 15 | + |
| 16 | +For instance, if we have some variable `y`, and we want to regress it |
| 17 | +against some other variables `x`, `a`, `b`, and the `interaction |
16 | 18 | <https://secure.wikimedia.org/wikipedia/en/wiki/Interaction_%28statistics%29>`_ |
17 | | -of ``a`` and ``b``, then we simply write:: |
| 19 | +of `a` and `b`, then we simply write:: |
18 | 20 |
|
19 | | - y ~ x + a + b + a:b |
| 21 | + patsy.dmatrices("y ~ x + a + b + a:b", data) |
20 | 22 |
|
21 | 23 | and Patsy takes care of building appropriate matrices. Furthermore, |
22 | 24 | it: |
@@ -61,9 +63,9 @@ The current release may be downloaded from the Python Package index at |
61 | 63 | http://pypi.python.org/pypi/patsy/ |
62 | 64 |
|
63 | 65 | Or the latest *development version* may be found in our `Git |
64 | | -repository <https://github.com/patsy/patsy>`_:: |
| 66 | +repository <https://github.com/pydata/patsy>`_:: |
65 | 67 |
|
66 | | - git clone git://github.com/patsy/patsy.git |
| 68 | + git clone git://github.com/pydata/patsy.git |
67 | 69 |
|
68 | 70 | Requirements |
69 | 71 | ------------ |
@@ -91,9 +93,16 @@ Contact |
91 | 93 |
|
92 | 94 | Post your suggestions and questions directly to the `pydata mailing |
93 | 95 | list <https://groups.google.com/group/pydata>`_ |
94 | | -(pydata@googlegroups.com), or to our `bug tracker |
95 | | -<https://github.com/patsy/patsy/issues>`_. You could also |
| 96 | +(pydata@googlegroups.com, `gmane archive |
| 97 | +<http://news.gmane.org/gmane.comp.python.pydata>`_), or to our `bug |
| 98 | +tracker <https://github.com/pydata/patsy/issues>`_. You could also |
96 | 99 | contact `Nathaniel J. Smith <mailto:njs@pobox.com>`_ directly, but |
97 | 100 | really the mailing list is almost always a better bet, because more |
98 | 101 | people will see your query and others will be able to benefit from any |
99 | 102 | answers you get. |
| 103 | + |
| 104 | +License |
| 105 | +------- |
| 106 | + |
| 107 | +2-clause BSD. See the file `COPYING |
| 108 | +<https://github.com/pydata/patsy/blob/master/COPYING>`_ for details. |
0 commit comments