Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API: provide Rolling/Expanding/EWM objects for deferred rolling type calculations #10702 #11603

Merged
merged 8 commits into from
Dec 19, 2015
Merged

API: provide Rolling/Expanding/EWM objects for deferred rolling type calculations #10702 #11603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3c23dc9
API: provide Rolling/Expanding/EWM objects for deferred rolling type …
jreback Nov 1, 2015
36fb835
BUG/API: consistency in .agg with nested dicts #9052
jreback Nov 21, 2015
9587d46
DOC: update docs for back-refs to groupby & window functions
jreback Nov 21, 2015
e47bd99
DEPR: removal of expanding_corr_pairwise/rolling_cor_pairwise, xref #…
jreback Nov 22, 2015
3156395
DEPR: deprecate pd.rolling_*, pd.expanding_*, pd.ewm*
jreback Nov 22, 2015
0bbe110
DOC: minor doc corrections
jreback Nov 25, 2015
05eb20f
DEPR: deprecate freq/how arguments to window functions
jreback Nov 30, 2015
1890a88
cleanup based on comments
jreback Dec 15, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 85 additions & 63 deletions doc/source/api.rst
View file
Open in desktop
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,78 @@ 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 ``.expanding`` calls: :func:`pandas.DataFrame.expanding`, :func:`pandas.Series.expanding`, etc.
EWM objects are returned by ``.ewm`` 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.cov
Rolling.skew
Rolling.kurt
Rolling.apply
Rolling.quantile
Window.mean
Window.sum

.. _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.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