Skip to content

Commit

Permalink
API: add doc examples for #9052
Browse files Browse the repository at this point in the history
  • Loading branch information
jreback committed Feb 2, 2016
1 parent 750556b commit e243f18
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions doc/source/whatsnew/v0.18.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,63 @@ New API

In the new API, you can either downsample OR upsample. The prior implementation would allow you to pass an aggregator function (like ``mean``) even though you were upsampling, providing a bit of confusion.

.. _whatsnew_0180.breaking.aggregation:

Aggregation API clarifictions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

As part of the new API for :ref:`window functions <whatsnew_0180.enhancements.moments>` and :ref:`resampling <whatsnew_0180.resample>`, aggregation functions have been
clarified. (:issue:`9052`). A full set of examples are presented in :ref:`groupby <groupby.aggregation>`.

Here are the available methodologies and changes for these aggregations.

.. ipython:: python

df = pd.DataFrame({'A': ['foo', 'bar', 'foo', 'bar',
'foo', 'bar', 'foo', 'foo'],
'B': ['one', 'one', 'two', 'three',
'two', 'two', 'one', 'three'],
'C': np.random.randn(8),
'D': np.arange(8)})

grouped = df.groupby(['A', 'B'])

Passing a single function or a list of aggregation functions

.. ipython:: python

grouped[['D','C']].agg(['sum','mean'])


Passing a single level dictionary will perform aggregations and name
the result columns as the keys.

.. ipython:: python

grouped['D'].agg({'result1': np.sum,
'result2': np.mean})

You can also pass a single level dictionary where the keys are the column names.

.. ipython:: python

grouped.agg({'C': 'sum', 'D': 'std'})

Finally you can pass a nested dictionary to enable specific functions on specific
columns and have renaming.

.. ipython:: python

grouped.agg({'C': {'summer': 'sum'}, 'D' : {'stddev':'std'}})

The change in 0.18.0 is to disallow the following, which could be ambiguous,
and will now raise a ``SpecificationError``.

.. code-block:: python

grouped.agg({'summer': {'C': 'sum'}, 'stddev' : {'D':'std'}})


Changes to eval
^^^^^^^^^^^^^^^

Expand Down

0 comments on commit e243f18

Please sign in to comment.