Skip to content

Commit

Permalink
DOC: update docs for back-refs to groupby & window functions
Browse files Browse the repository at this point in the history
  • Loading branch information
jreback committed Dec 19, 2015
1 parent 36fb835 commit 9587d46
Show file tree
Hide file tree
Showing 7 changed files with 986 additions and 570 deletions.
149 changes: 86 additions & 63 deletions doc/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,72 +194,16 @@ Top-level evaluation

eval

Standard moving window functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/

rolling_count
rolling_sum
rolling_mean
rolling_median
rolling_var
rolling_std
rolling_min
rolling_max
rolling_corr
rolling_corr_pairwise
rolling_cov
rolling_skew
rolling_kurt
rolling_apply
rolling_quantile
rolling_window

.. _api.functions_expanding:

Standard expanding window functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/

expanding_count
expanding_sum
expanding_mean
expanding_median
expanding_var
expanding_std
expanding_min
expanding_max
expanding_corr
expanding_corr_pairwise
expanding_cov
expanding_skew
expanding_kurt
expanding_apply
expanding_quantile

Exponentially-weighted moving window functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/

ewma
ewmstd
ewmvar
ewmcorr
ewmcov

.. _api.series:

Series
------

Constructor
~~~~~~~~~~~

.. currentmodule:: pandas

.. autosummary::
:toctree: generated/

Expand Down Expand Up @@ -344,14 +288,17 @@ Binary operator functions
Series.ne
Series.eq

Function application, GroupBy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Function application, GroupBy & Window
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

Series.apply
Series.map
Series.groupby
Series.rolling
Series.expanding
Series.ewm

.. _api.series.stats:

Expand Down Expand Up @@ -846,14 +793,17 @@ Binary operator functions
DataFrame.combine
DataFrame.combine_first

Function application, GroupBy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Function application, GroupBy & Window
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

DataFrame.apply
DataFrame.applymap
DataFrame.groupby
DataFrame.rolling
DataFrame.expanding
DataFrame.ewm

.. _api.dataframe.stats:

Expand Down Expand Up @@ -1551,6 +1501,79 @@ Conversion
TimedeltaIndex.to_series
TimedeltaIndex.round

Window
------
.. currentmodule:: pandas.core.window

Rolling objects are returned by rolling calls: :func:`pandas.DataFrame.rolling`, :func:`pandas.Series.rolling`, etc.
Expanding objects are returned by rolling calls: :func:`pandas.DataFrame.expanding`, :func:`pandas.Series.expanding`, etc.
EWM objects are returned by rolling calls: :func:`pandas.DataFrame.ewm`, :func:`pandas.Series.ewm`, etc.

Standard moving window functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: pandas.core.window

.. autosummary::
:toctree: generated/

Rolling.count
Rolling.sum
Rolling.mean
Rolling.median
Rolling.var
Rolling.std
Rolling.min
Rolling.max
Rolling.corr
Rolling.corr_pairwise
Rolling.cov
Rolling.skew
Rolling.kurt
Rolling.apply
Rolling.quantile
Rolling.window

.. _api.functions_expanding:

Standard expanding window functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: pandas.core.window

.. autosummary::
:toctree: generated/

Expanding.count
Expanding.sum
Expanding.mean
Expanding.median
Expanding.var
Expanding.std
Expanding.min
Expanding.max
Expanding.corr
Expanding.corr_pairwise
Expanding.cov
Expanding.skew
Expanding.kurt
Expanding.apply
Expanding.quantile

Exponentially-weighted moving window functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: pandas.core.window

.. autosummary::
:toctree: generated/

EWM.mean
EWM.std
EWM.var
EWM.corr
EWM.cov

GroupBy
-------
.. currentmodule:: pandas.core.groupby
Expand Down
Loading

0 comments on commit 9587d46

Please sign in to comment.