Skip to content

Commit

Permalink
DOC: Improving docstring of take method
Browse files Browse the repository at this point in the history
  • Loading branch information
matagus authored and gfyoung committed Aug 21, 2017
1 parent 91245a7 commit 0d49def
Showing 1 changed file with 40 additions and 1 deletion.
41 changes: 40 additions & 1 deletion pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -2063,7 +2063,8 @@ def __delitem__(self, key):

def take(self, indices, axis=0, convert=True, is_copy=True, **kwargs):
"""
Analogous to ndarray.take
Return an object formed from the elements in the given indices along an
axis
Parameters
----------
Expand All @@ -2072,6 +2073,44 @@ def take(self, indices, axis=0, convert=True, is_copy=True, **kwargs):
convert : translate neg to pos indices (default)
is_copy : mark the returned frame as a copy
Examples
--------
>>> import numpy as np
>>> import pandas as pd
>>> df = pd.DataFrame([('falcon', 'bird', 389.0),
('parrot', 'bird', 24.0),
('lion', 'mammal', 80.5),
('monkey', 'mammal', np.nan)],
columns=('name', 'class', 'max_speed'))
>>> df
name class max_speed
0 falcon bird 389.0
1 parrot bird 24.0
2 lion mammal 80.5
3 monkey mammal NaN
Take elements at indices 0 and 3 along the axis 0 (default)
>>> df.take([0, 3])
0 falcon bird 389.0
3 monkey mammal NaN
Take elements at indices 1 and 2 along the axis 1
>>> df.take([1, 2], axis=1)
class max_speed
0 bird 389.0
1 bird 24.0
2 mammal 80.5
3 mammal NaN
Also, we may take elements using negative integers for pos indices
>>> df.take([-1, -2])
name class max_speed
3 monkey mammal NaN
2 lion mammal 80.5
Returns
-------
taken : type of caller
Expand Down

0 comments on commit 0d49def

Please sign in to comment.