Essential basic functionality¶
Here we discuss a lot of the essential functionality common to the pandas data structures. Here’s how to create some of the objects used in the examples from the previous section:
In [1]: index = date_range('1/1/2000', periods=8)
In [2]: s = Series(randn(5), index=['a', 'b', 'c', 'd', 'e'])
In [3]: df = DataFrame(randn(8, 3), index=index,
...: columns=['A', 'B', 'C'])
...:
In [4]: wp = Panel(randn(2, 5, 4), items=['Item1', 'Item2'],
...: major_axis=date_range('1/1/2000', periods=5),
...: minor_axis=['A', 'B', 'C', 'D'])
...:
Head and Tail¶
To view a small sample of a Series or DataFrame object, use the head and tail methods. The default number of elements to display is five, but you may pass a custom number.
In [5]: long_series = Series(randn(1000))
In [6]: long_series.head()
Out[6]:
0 -0.188451
1 -1.138342
2 -0.762153
3 0.984686
4 -0.319760
In [7]: long_series.tail(3)
Out[7]:
997 0.726557
998 1.213842
999 0.184515
Attributes and the raw ndarray(s)¶
pandas objects have a number of attributes enabling you to access the metadata
- shape: gives the axis dimensions of the object, consistent with ndarray
- Axis labels
- Series: index (only axis)
- DataFrame: index (rows) and columns
- Panel: items, major_axis, and minor_axis
Note, these attributes can be safely assigned to!
In [8]: df[:2]
Out[8]:
A B C
2000-01-01 1.557785 -0.735852 1.405917
2000-01-02 -0.796967 -0.476187 1.434956
In [9]: df.columns = [x.lower() for x in df.columns]
In [10]: df
Out[10]:
a b c
2000-01-01 1.557785 -0.735852 1.405917
2000-01-02 -0.796967 -0.476187 1.434956
2000-01-03 0.984711 -1.859749 -2.792244
2000-01-04 -1.282738 0.406517 0.215237
2000-01-05 0.391639 0.215411 -0.913940
2000-01-06 -0.405730 0.490710 1.900912
2000-01-07 0.203620 -0.465149 -1.535344
2000-01-08 -0.717735 -0.250771 0.385471
To get the actual data inside a data structure, one need only access the values property:
In [11]: s.values
Out[11]: array([ 0.5746, 0.4236, -0.8229, -2.03 , 0.2233])
In [12]: df.values
Out[12]:
array([[ 1.5578, -0.7359, 1.4059],
[-0.797 , -0.4762, 1.435 ],
[ 0.9847, -1.8597, -2.7922],
[-1.2827, 0.4065, 0.2152],
[ 0.3916, 0.2154, -0.9139],
[-0.4057, 0.4907, 1.9009],
[ 0.2036, -0.4651, -1.5353],
[-0.7177, -0.2508, 0.3855]])
In [13]: wp.values
Out[13]:
array([[[ 0.4482, 0.7109, 0.6479, -0.3194],
[ 1.2473, -0.7966, 0.3117, 1.1295],
[-0.2797, -0.2142, -0.2773, 0.1329],
[-1.0907, -0.1462, 1.2782, 1.0191],
[-0.3005, -1.2065, 0.9802, -1.1518]],
[[-0.7268, -0.6937, -1.32 , 1.4824],
[-0.7964, -0.5281, 0.3617, 0.579 ],
[-0.5011, -0.4274, -2.0525, -0.1184],
[-0.8667, 1.0715, 1.0917, 0.6054],
[-1.6769, -0.3194, 0.3732, -1.5992]]])
If a DataFrame or Panel contains homogeneously-typed data, the ndarray can actually be modified in-place, and the changes will be reflected in the data structure. For heterogeneous data (e.g. some of the DataFrame’s columns are not all the same dtype), this will not be the case. The values attribute itself, unlike the axis labels, cannot be assigned to.
Note
When working with heterogeneous data, the dtype of the resulting ndarray will be chosen to accommodate all of the data involved. For example, if strings are involved, the result will be of object dtype. If there are only floats and integers, the resulting array will be of float dtype.
Flexible binary operations¶
With binary operations between pandas data structures, there are two key points of interest:
- Broadcasting behavior between higher- (e.g. DataFrame) and lower-dimensional (e.g. Series) objects.
- Missing data in computations
We will demonstrate how to manage these issues independently, though they can be handled simultaneously.
Matching / broadcasting behavior¶
DataFrame has the methods add, sub, mul, div and related functions radd, rsub, ... for carrying out binary operations. For broadcasting behavior, Series input is of primary interest. Using these functions, you can use to either match on the index or columns via the axis keyword:
In [14]: df
Out[14]:
one three two
a -0.626485 NaN -0.055531
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
d NaN 0.728111 -0.097203
In [15]: row = df.ix[1]
In [16]: column = df['two']
In [17]: df.sub(row, axis='columns')
Out[17]:
one three two
a 0.018233 NaN -1.147971
b 0.000000 0.000000 0.000000
c 2.095789 0.349558 -2.795088
d NaN 0.696388 -1.189642
In [18]: df.sub(row, axis=1)
Out[18]:
one three two
a 0.018233 NaN -1.147971
b 0.000000 0.000000 0.000000
c 2.095789 0.349558 -2.795088
d NaN 0.696388 -1.189642
In [19]: df.sub(column, axis='index')
Out[19]:
one three two
a -0.570954 NaN 0
b -1.737158 -1.060716 0
c 3.153719 2.083930 0
d NaN 0.825314 0
In [20]: df.sub(column, axis=0)
Out[20]:
one three two
a -0.570954 NaN 0
b -1.737158 -1.060716 0
c 3.153719 2.083930 0
d NaN 0.825314 0
With Panel, describing the matching behavior is a bit more difficult, so the arithmetic methods instead (and perhaps confusingly?) give you the option to specify the broadcast axis. For example, suppose we wished to demean the data over a particular axis. This can be accomplished by taking the mean over an axis and broadcasting over the same axis:
In [21]: major_mean = wp.mean(axis='major')
In [22]: major_mean
Out[22]:
Item1 Item2
A 0.004907 -0.913578
B -0.330524 -0.179416
C 0.588141 -0.309175
D 0.162039 0.189822
In [23]: wp.sub(major_mean, axis='major')
Out[23]:
<class 'pandas.core.panel.Panel'>
Dimensions: 2 (items) x 5 (major) x 4 (minor)
Items: Item1 to Item2
Major axis: 2000-01-01 00:00:00 to 2000-01-05 00:00:00
Minor axis: A to D
And similarly for axis="items" and axis="minor".
Note
I could be convinced to make the axis argument in the DataFrame methods match the broadcasting behavior of Panel. Though it would require a transition period so users can change their code...
Missing data / operations with fill values¶
In Series and DataFrame (though not yet in Panel), the arithmetic functions have the option of inputting a fill_value, namely a value to substitute when at most one of the values at a location are missing. For example, when adding two DataFrame objects, you may wish to treat NaN as 0 unless both DataFrames are missing that value, in which case the result will be NaN (you can later replace NaN with some other value using fillna if you wish).
In [24]: df
Out[24]:
one three two
a -0.626485 NaN -0.055531
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
d NaN 0.728111 -0.097203
In [25]: df2
Out[25]:
one three two
a -0.626485 1.000000 -0.055531
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
d NaN 0.728111 -0.097203
In [26]: df + df2
Out[26]:
one three two
a -1.252970 NaN -0.111063
b -1.289437 0.063447 2.184878
c 2.902142 0.762562 -3.405297
d NaN 1.456222 -0.194406
In [27]: df.add(df2, fill_value=0)
Out[27]:
one three two
a -1.252970 1.000000 -0.111063
b -1.289437 0.063447 2.184878
c 2.902142 0.762562 -3.405297
d NaN 1.456222 -0.194406
Flexible Comparisons¶
Starting in v0.8, pandas introduced binary comparison methods eq, ne, lt, gt, le, and ge to Series and DataFrame whose behavior is analogous to the binary arithmetic operations described above:
In [28]: df.gt(df2)
Out[28]:
one three two
a False False False
b False False False
c False False False
d False False False
In [29]: df2.ne(df)
Out[29]:
one three two
a False True False
b False False False
c False False False
d True False False
Combining overlapping data sets¶
A problem occasionally arising is the combination of two similar data sets where values in one are preferred over the other. An example would be two data series representing a particular economic indicator where one is considered to be of “higher quality”. However, the lower quality series might extend further back in history or have more complete data coverage. As such, we would like to combine two DataFrame objects where missing values in one DataFrame are conditionally filled with like-labeled values from the other DataFrame. The function implementing this operation is combine_first, which we illustrate:
In [30]: df1 = DataFrame({'A' : [1., np.nan, 3., 5., np.nan],
....: 'B' : [np.nan, 2., 3., np.nan, 6.]})
....:
In [31]: df2 = DataFrame({'A' : [5., 2., 4., np.nan, 3., 7.],
....: 'B' : [np.nan, np.nan, 3., 4., 6., 8.]})
....:
In [32]: df1
Out[32]:
A B
0 1 NaN
1 NaN 2
2 3 3
3 5 NaN
4 NaN 6
In [33]: df2
Out[33]:
A B
0 5 NaN
1 2 NaN
2 4 3
3 NaN 4
4 3 6
5 7 8
In [34]: df1.combine_first(df2)
Out[34]:
A B
0 1 NaN
1 2 2
2 3 3
3 5 4
4 3 6
5 7 8
General DataFrame Combine¶
The combine_first method above calls the more general DataFrame method combine. This method takes another DataFrame and a combiner function, aligns the input DataFrame and then passes the combiner function pairs of Series (ie, columns whose names are the same).
So, for instance, to reproduce combine_first as above:
In [35]: combiner = lambda x, y: np.where(isnull(x), y, x)
In [36]: df1.combine(df2, combiner)
Out[36]:
A B
0 1 NaN
1 2 2
2 3 3
3 5 4
4 3 6
5 7 8
Descriptive statistics¶
A large number of methods for computing descriptive statistics and other related operations on Series, DataFrame, and Panel. Most of these are aggregations (hence producing a lower-dimensional result) like sum, mean, and quantile, but some of them, like cumsum and cumprod, produce an object of the same size. Generally speaking, these methods take an axis argument, just like ndarray.{sum, std, ...}, but the axis can be specified by name or integer:
- Series: no axis argument needed
- DataFrame: “index” (axis=0, default), “columns” (axis=1)
- Panel: “items” (axis=0), “major” (axis=1, default), “minor” (axis=2)
For example:
In [37]: df
Out[37]:
one three two
a -0.626485 NaN -0.055531
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
d NaN 0.728111 -0.097203
In [38]: df.mean(0)
Out[38]:
one 0.059956
three 0.380372
two -0.190736
In [39]: df.mean(1)
Out[39]:
a -0.341008
b 0.159815
c 0.043235
d 0.315454
All such methods have a skipna option signaling whether to exclude missing data (True by default):
In [40]: df.sum(0, skipna=False)
Out[40]:
one NaN
three NaN
two -0.762944
In [41]: df.sum(axis=1, skipna=True)
Out[41]:
a -0.682016
b 0.479444
c 0.129704
d 0.630908
Combined with the broadcasting / arithmetic behavior, one can describe various statistical procedures, like standardization (rendering data zero mean and standard deviation 1), very concisely:
In [42]: ts_stand = (df - df.mean()) / df.std()
In [43]: ts_stand.std()
Out[43]:
one 1
three 1
two 1
In [44]: xs_stand = df.sub(df.mean(1), axis=0).div(df.std(1), axis=0)
In [45]: xs_stand.std(1)
Out[45]:
a 1
b 1
c 1
d 1
Note that methods like cumsum and cumprod preserve the location of NA values:
In [46]: df.cumsum()
Out[46]:
one three two
a -0.626485 NaN -0.055531
b -1.271203 0.031723 1.036908
c 0.179868 0.413005 -0.665740
d NaN 1.141116 -0.762944
Here is a quick reference summary table of common functions. Each also takes an optional level parameter which applies only if the object has a hierarchical index.
| Function | Description |
|---|---|
| count | Number of non-null observations |
| sum | Sum of values |
| mean | Mean of values |
| mad | Mean absolute deviation |
| median | Arithmetic median of values |
| min | Minimum |
| max | Maximum |
| abs | Absolute Value |
| prod | Product of values |
| std | Unbiased standard deviation |
| var | Unbiased variance |
| skew | Unbiased skewness (3rd moment) |
| kurt | Unbiased kurtosis (4th moment) |
| quantile | Sample quantile (value at %) |
| cumsum | Cumulative sum |
| cumprod | Cumulative product |
| cummax | Cumulative maximum |
| cummin | Cumulative minimum |
Note that by chance some NumPy methods, like mean, std, and sum, will exclude NAs on Series input by default:
In [47]: np.mean(df['one'])
Out[47]: 0.05995590919309346
In [48]: np.mean(df['one'].values)
Out[48]: nan
Series also has a method nunique which will return the number of unique non-null values:
In [49]: series = Series(randn(500))
In [50]: series[20:500] = np.nan
In [51]: series[10:20] = 5
In [52]: series.nunique()
Out[52]: 11
Summarizing data: describe¶
There is a convenient describe function which computes a variety of summary statistics about a Series or the columns of a DataFrame (excluding NAs of course):
In [53]: series = Series(randn(1000))
In [54]: series[::2] = np.nan
In [55]: series.describe()
Out[55]:
count 500.000000
mean 0.031965
std 1.013558
min -3.264947
25% -0.674226
50% 0.041992
75% 0.752253
max 2.902452
In [56]: frame = DataFrame(randn(1000, 5), columns=['a', 'b', 'c', 'd', 'e'])
In [57]: frame.ix[::2] = np.nan
In [58]: frame.describe()
Out[58]:
a b c d e
count 500.000000 500.000000 500.000000 500.000000 500.000000
mean 0.064709 -0.012994 -0.003211 0.031999 -0.001916
std 0.995002 1.035122 1.027049 1.032520 1.003642
min -2.974590 -3.248169 -3.949651 -3.053483 -3.218247
25% -0.597821 -0.672689 -0.647099 -0.706440 -0.655058
50% 0.040400 -0.067920 -0.082346 0.047131 -0.049408
75% 0.793558 0.682013 0.648707 0.676636 0.691038
max 2.571295 3.221779 2.850843 3.074321 3.369975
For a non-numerical Series object, describe will give a simple summary of the number of unique values and most frequently occurring values:
In [59]: s = Series(['a', 'a', 'b', 'b', 'a', 'a', np.nan, 'c', 'd', 'a'])
In [60]: s.describe()
Out[60]:
count 9
unique 4
top a
freq 5
There also is a utility function, value_range which takes a DataFrame and returns a series with the minimum/maximum values in the DataFrame.
Index of Min/Max Values¶
The idxmin and idxmax functions on Series and DataFrame compute the index labels with the minimum and maximum corresponding values:
In [61]: s1 = Series(randn(5))
In [62]: s1
Out[62]:
0 2.808389
1 2.199941
2 0.389912
3 1.026645
4 1.973982
In [63]: s1.idxmin(), s1.idxmax()
Out[63]: (2, 0)
In [64]: df1 = DataFrame(randn(5,3), columns=['A','B','C'])
In [65]: df1
Out[65]:
A B C
0 -0.148950 1.218136 1.316456
1 -1.284399 -0.458461 1.310663
2 1.319612 -3.017707 1.161933
3 -0.243407 0.572340 0.320233
4 0.517711 -0.116664 0.134331
In [66]: df1.idxmin(axis=0)
Out[66]:
A 1
B 2
C 4
In [67]: df1.idxmax(axis=1)
Out[67]:
0 C
1 C
2 A
3 B
4 A
When there are multiple rows (or columns) matching the minimum or maximum value, idxmin and idxmax return the first matching index:
In [68]: df3 = DataFrame([2, 1, 1, 3, np.nan], columns=['A'], index=list('edcba'))
In [69]: df3
Out[69]:
A
e 2
d 1
c 1
b 3
a NaN
In [70]: df3['A'].idxmin()
Out[70]: 'd'
Value counts (histogramming)¶
The value_counts Series method and top-level function computes a histogram of a 1D array of values. It can also be used as a function on regular arrays:
In [71]: data = np.random.randint(0, 7, size=50)
In [72]: data
Out[72]:
array([0, 0, 2, 1, 1, 1, 0, 2, 5, 6, 3, 4, 0, 3, 1, 2, 4, 3, 3, 2, 2, 0, 4,
5, 1, 1, 0, 1, 4, 0, 2, 0, 5, 1, 2, 0, 2, 2, 4, 0, 6, 5, 0, 5, 2, 3,
0, 6, 5, 3])
In [73]: s = Series(data)
In [74]: s.value_counts()
Out[74]:
0 12
2 10
1 8
5 6
3 6
4 5
6 3
In [75]: value_counts(data)
Out[75]:
0 12
2 10
1 8
5 6
3 6
4 5
6 3
Discretization and quantiling¶
Continuous values can be discretized using the cut (bins based on values) and qcut (bins based on sample quantiles) functions:
In [76]: arr = np.random.randn(20)
In [77]: factor = cut(arr, 4)
In [78]: factor
Out[78]:
Categorical:
array([(-1.0147, 0.034], (0.034, 1.0827], (0.034, 1.0827],
(-1.0147, 0.034], (-1.0147, 0.034], (-1.0147, 0.034],
(-1.0147, 0.034], (-1.0147, 0.034], (-1.0147, 0.034],
(1.0827, 2.131], (1.0827, 2.131], (-1.0147, 0.034],
(-1.0147, 0.034], (-1.0147, 0.034], (-2.0676, -1.0147],
(0.034, 1.0827], (-1.0147, 0.034], (0.034, 1.0827], (0.034, 1.0827],
(-2.0676, -1.0147]], dtype=object)
Levels (4): Index([(-2.0676, -1.0147], (-1.0147, 0.034],
(0.034, 1.0827], (1.0827, 2.131]], dtype=object)
In [79]: factor = cut(arr, [-5, -1, 0, 1, 5])
In [80]: factor
Out[80]:
Categorical:
array([(-1, 0], (0, 1], (1, 5], (-1, 0], (0, 1], (-1, 0], (-1, 0], (-1, 0],
(-1, 0], (1, 5], (1, 5], (-1, 0], (-1, 0], (-1, 0], (-5, -1],
(0, 1], (-1, 0], (0, 1], (0, 1], (-5, -1]], dtype=object)
Levels (4): Index([(-5, -1], (-1, 0], (0, 1], (1, 5]], dtype=object)
qcut computes sample quantiles. For example, we could slice up some normally distributed data into equal-size quartiles like so:
In [81]: arr = np.random.randn(30)
In [82]: factor = qcut(arr, [0, .25, .5, .75, 1])
In [83]: factor
Out[83]:
Categorical:
array([[-2.411, -0.783], [-2.411, -0.783], (0.778, 1.642],
(-0.783, -0.222], (-0.783, -0.222], (-0.222, 0.778],
(-0.783, -0.222], (-0.783, -0.222], (0.778, 1.642], (0.778, 1.642],
[-2.411, -0.783], (0.778, 1.642], [-2.411, -0.783], (0.778, 1.642],
[-2.411, -0.783], (-0.222, 0.778], [-2.411, -0.783],
[-2.411, -0.783], (-0.222, 0.778], (0.778, 1.642], (-0.222, 0.778],
(-0.783, -0.222], (0.778, 1.642], (-0.222, 0.778], (-0.222, 0.778],
(-0.783, -0.222], (-0.783, -0.222], (-0.222, 0.778],
[-2.411, -0.783], (0.778, 1.642]], dtype=object)
Levels (4): Index([[-2.411, -0.783], (-0.783, -0.222], (-0.222, 0.778],
(0.778, 1.642]], dtype=object)
In [84]: value_counts(factor)
Out[84]:
[-2.411, -0.783] 8
(0.778, 1.642] 8
(-0.783, -0.222] 7
(-0.222, 0.778] 7
Function application¶
Arbitrary functions can be applied along the axes of a DataFrame or Panel using the apply method, which, like the descriptive statistics methods, take an optional axis argument:
In [85]: df.apply(np.mean)
Out[85]:
one 0.059956
three 0.380372
two -0.190736
In [86]: df.apply(np.mean, axis=1)
Out[86]:
a -0.341008
b 0.159815
c 0.043235
d 0.315454
In [87]: df.apply(lambda x: x.max() - x.min())
Out[87]:
one 2.095789
three 0.696388
two 2.795088
In [88]: df.apply(np.cumsum)
Out[88]:
one three two
a -0.626485 NaN -0.055531
b -1.271203 0.031723 1.036908
c 0.179868 0.413005 -0.665740
d NaN 1.141116 -0.762944
In [89]: df.apply(np.exp)
Out[89]:
one three two
a 0.534467 NaN 0.945982
b 0.524810 1.032232 2.981538
c 4.267683 1.464159 0.182200
d NaN 2.071165 0.907372
Depending on the return type of the function passed to apply, the result will either be of lower dimension or the same dimension.
apply combined with some cleverness can be used to answer many questions about a data set. For example, suppose we wanted to extract the date where the maximum value for each column occurred:
In [90]: tsdf = DataFrame(randn(1000, 3), columns=['A', 'B', 'C'],
....: index=date_range('1/1/2000', periods=1000))
....:
In [91]: tsdf.apply(lambda x: x.index[x.dropna().argmax()])
Out[91]:
A 2001-04-29 00:00:00
B 2000-12-01 00:00:00
C 2000-08-20 00:00:00
You may also pass additional arguments and keyword arguments to the apply method. For instance, consider the following function you would like to apply:
def subtract_and_divide(x, sub, divide=1):
return (x - sub) / divide
You may then apply this function as follows:
df.apply(subtract_and_divide, args=(5,), divide=3)
Another useful feature is the ability to pass Series methods to carry out some Series operation on each column or row:
In [92]: tsdf
Out[92]:
A B C
2000-01-01 -0.534797 -0.763381 0.756118
2000-01-02 0.313787 -0.519311 1.079536
2000-01-03 0.055777 -1.190207 -1.953261
2000-01-04 NaN NaN NaN
2000-01-05 NaN NaN NaN
2000-01-06 NaN NaN NaN
2000-01-07 NaN NaN NaN
2000-01-08 0.481332 1.342729 -1.118054
2000-01-09 -0.853595 -0.959138 0.618236
2000-01-10 -0.657237 1.480537 -0.410058
In [93]: tsdf.apply(Series.interpolate)
Out[93]:
A B C
2000-01-01 -0.534797 -0.763381 0.756118
2000-01-02 0.313787 -0.519311 1.079536
2000-01-03 0.055777 -1.190207 -1.953261
2000-01-04 0.140888 -0.683620 -1.786219
2000-01-05 0.225999 -0.177033 -1.619178
2000-01-06 0.311110 0.329555 -1.452137
2000-01-07 0.396221 0.836142 -1.285096
2000-01-08 0.481332 1.342729 -1.118054
2000-01-09 -0.853595 -0.959138 0.618236
2000-01-10 -0.657237 1.480537 -0.410058
Finally, apply takes an argument raw which is False by default, which converts each row or column into a Series before applying the function. When set to True, the passed function will instead receive an ndarray object, which has positive performance implications if you do not need the indexing functionality.
See also
The section on GroupBy demonstrates related, flexible functionality for grouping by some criterion, applying, and combining the results into a Series, DataFrame, etc.
Applying elementwise Python functions¶
Since not all functions can be vectorized (accept NumPy arrays and return another array or value), the methods applymap on DataFrame and analogously map on Series accept any Python function taking a single value and returning a single value. For example:
In [94]: f = lambda x: len(str(x))
In [95]: df['one'].map(f)
Out[95]:
a 15
b 15
c 13
d 3
Name: one
In [96]: df.applymap(f)
Out[96]:
one three two
a 15 3 16
b 15 15 12
c 13 14 14
d 3 14 16
Series.map has an additional feature which is that it can be used to easily “link” or “map” values defined by a secondary series. This is closely related to merging/joining functionality:
In [97]: s = Series(['six', 'seven', 'six', 'seven', 'six'],
....: index=['a', 'b', 'c', 'd', 'e'])
....:
In [98]: t = Series({'six' : 6., 'seven' : 7.})
In [99]: s
Out[99]:
a six
b seven
c six
d seven
e six
In [100]: s.map(t)
Out[100]:
a 6
b 7
c 6
d 7
e 6
Reindexing and altering labels¶
reindex is the fundamental data alignment method in pandas. It is used to implement nearly all other features relying on label-alignment functionality. To reindex means to conform the data to match a given set of labels along a particular axis. This accomplishes several things:
- Reorders the existing data to match a new set of labels
- Inserts missing value (NA) markers in label locations where no data for that label existed
- If specified, fill data for missing labels using logic (highly relevant to working with time series data)
Here is a simple example:
In [101]: s = Series(randn(5), index=['a', 'b', 'c', 'd', 'e'])
In [102]: s
Out[102]:
a -0.046953
b 0.169886
c 1.339587
d 0.594211
e -0.769663
In [103]: s.reindex(['e', 'b', 'f', 'd'])
Out[103]:
e -0.769663
b 0.169886
f NaN
d 0.594211
Here, the f label was not contained in the Series and hence appears as NaN in the result.
With a DataFrame, you can simultaneously reindex the index and columns:
In [104]: df
Out[104]:
one three two
a -0.626485 NaN -0.055531
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
d NaN 0.728111 -0.097203
In [105]: df.reindex(index=['c', 'f', 'b'], columns=['three', 'two', 'one'])
Out[105]:
three two one
c 0.381281 -1.702648 1.451071
f NaN NaN NaN
b 0.031723 1.092439 -0.644718
For convenience, you may utilize the reindex_axis method, which takes the labels and a keyword axis parameter.
Note that the Index objects containing the actual axis labels can be shared between objects. So if we have a Series and a DataFrame, the following can be done:
In [106]: rs = s.reindex(df.index)
In [107]: rs
Out[107]:
a -0.046953
b 0.169886
c 1.339587
d 0.594211
In [108]: rs.index is df.index
Out[108]: True
This means that the reindexed Series’s index is the same Python object as the DataFrame’s index.
See also
Advanced indexing is an even more concise way of doing reindexing.
Note
When writing performance-sensitive code, there is a good reason to spend some time becoming a reindexing ninja: many operations are faster on pre-aligned data. Adding two unaligned DataFrames internally triggers a reindexing step. For exploratory analysis you will hardly notice the difference (because reindex has been heavily optimized), but when CPU cycles matter sprinking a few explicit reindex calls here and there can have an impact.
Reindexing to align with another object¶
You may wish to take an object and reindex its axes to be labeled the same as another object. While the syntax for this is straightforward albeit verbose, it is a common enough operation that the reindex_like method is available to make this simpler:
In [109]: df
Out[109]:
one three two
a -0.626485 NaN -0.055531
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
d NaN 0.728111 -0.097203
In [110]: df2
Out[110]:
one two
a -0.686441 0.166382
b -0.704674 1.314353
c 1.391115 -1.480735
In [111]: df.reindex_like(df2)
Out[111]:
one two
a -0.626485 -0.055531
b -0.644718 1.092439
c 1.451071 -1.702648
Reindexing with reindex_axis¶
Aligning objects with each other with align¶
The align method is the fastest way to simultaneously align two objects. It supports a join argument (related to joining and merging):
- join='outer': take the union of the indexes
- join='left': use the calling object’s index
- join='right': use the passed object’s index
- join='inner': intersect the indexes
It returns a tuple with both of the reindexed Series:
In [112]: s = Series(randn(5), index=['a', 'b', 'c', 'd', 'e'])
In [113]: s1 = s[:4]
In [114]: s2 = s[1:]
In [115]: s1.align(s2)
Out[115]:
(a -0.186036
b -1.388000
c 1.132770
d 0.091758
e NaN,
a NaN
b -1.388000
c 1.132770
d 0.091758
e -0.377121)
In [116]: s1.align(s2, join='inner')
Out[116]:
(b -1.388000
c 1.132770
d 0.091758,
b -1.388000
c 1.132770
d 0.091758)
In [117]: s1.align(s2, join='left')
Out[117]:
(a -0.186036
b -1.388000
c 1.132770
d 0.091758,
a NaN
b -1.388000
c 1.132770
d 0.091758)
For DataFrames, the join method will be applied to both the index and the columns by default:
In [118]: df.align(df2, join='inner')
Out[118]:
( one two
a -0.626485 -0.055531
b -0.644718 1.092439
c 1.451071 -1.702648,
one two
a -0.686441 0.166382
b -0.704674 1.314353
c 1.391115 -1.480735)
You can also pass an axis option to only align on the specified axis:
In [119]: df.align(df2, join='inner', axis=0)
Out[119]:
( one three two
a -0.626485 NaN -0.055531
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648,
one two
a -0.686441 0.166382
b -0.704674 1.314353
c 1.391115 -1.480735)
If you pass a Series to DataFrame.align, you can choose to align both objects either on the DataFrame’s index or columns using the axis argument:
In [120]: df.align(df2.ix[0], axis=1)
Out[120]:
( one three two
a -0.626485 NaN -0.055531
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
d NaN 0.728111 -0.097203,
one -0.686441
three NaN
two 0.166382
Name: a)
Filling while reindexing¶
reindex takes an optional parameter method which is a filling method chosen from the following table:
| Method | Action |
|---|---|
| pad / ffill | Fill values forward |
| bfill / backfill | Fill values backward |
Other fill methods could be added, of course, but these are the two most commonly used for time series data. In a way they only make sense for time series or otherwise ordered data, but you may have an application on non-time series data where this sort of “interpolation” logic is the correct thing to do. More sophisticated interpolation of missing values would be an obvious extension.
We illustrate these fill methods on a simple TimeSeries:
In [121]: rng = date_range('1/3/2000', periods=8)
In [122]: ts = Series(randn(8), index=rng)
In [123]: ts2 = ts[[0, 3, 6]]
In [124]: ts
Out[124]:
2000-01-03 0.739976
2000-01-04 1.109757
2000-01-05 1.759969
2000-01-06 -0.442726
2000-01-07 1.437525
2000-01-08 1.538104
2000-01-09 -0.515591
2000-01-10 0.730599
Freq: D
In [125]: ts2
Out[125]:
2000-01-03 0.739976
2000-01-06 -0.442726
2000-01-09 -0.515591
In [126]: ts2.reindex(ts.index)
Out[126]:
2000-01-03 0.739976
2000-01-04 NaN
2000-01-05 NaN
2000-01-06 -0.442726
2000-01-07 NaN
2000-01-08 NaN
2000-01-09 -0.515591
2000-01-10 NaN
Freq: D
In [127]: ts2.reindex(ts.index, method='ffill')
Out[127]:
2000-01-03 0.739976
2000-01-04 0.739976
2000-01-05 0.739976
2000-01-06 -0.442726
2000-01-07 -0.442726
2000-01-08 -0.442726
2000-01-09 -0.515591
2000-01-10 -0.515591
Freq: D
In [128]: ts2.reindex(ts.index, method='bfill')
Out[128]:
2000-01-03 0.739976
2000-01-04 -0.442726
2000-01-05 -0.442726
2000-01-06 -0.442726
2000-01-07 -0.515591
2000-01-08 -0.515591
2000-01-09 -0.515591
2000-01-10 NaN
Freq: D
Note the same result could have been achieved using fillna:
In [129]: ts2.reindex(ts.index).fillna(method='ffill')
Out[129]:
2000-01-03 0.739976
2000-01-04 0.739976
2000-01-05 0.739976
2000-01-06 -0.442726
2000-01-07 -0.442726
2000-01-08 -0.442726
2000-01-09 -0.515591
2000-01-10 -0.515591
Freq: D
Note these methods generally assume that the indexes are sorted. They may be modified in the future to be a bit more flexible but as time series data is ordered most of the time anyway, this has not been a major priority.
Dropping labels from an axis¶
A method closely related to reindex is the drop function. It removes a set of labels from an axis:
In [130]: df
Out[130]:
one three two
a -0.626485 NaN -0.055531
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
d NaN 0.728111 -0.097203
In [131]: df.drop(['a', 'd'], axis=0)
Out[131]:
one three two
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
In [132]: df.drop(['one'], axis=1)
Out[132]:
three two
a NaN -0.055531
b 0.031723 1.092439
c 0.381281 -1.702648
d 0.728111 -0.097203
Note that the following also works, but is a bit less obvious / clean:
In [133]: df.reindex(df.index - ['a', 'd'])
Out[133]:
one three two
b -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
Renaming / mapping labels¶
The rename method allows you to relabel an axis based on some mapping (a dict or Series) or an arbitrary function.
In [134]: s
Out[134]:
a -0.186036
b -1.388000
c 1.132770
d 0.091758
e -0.377121
In [135]: s.rename(str.upper)
Out[135]:
A -0.186036
B -1.388000
C 1.132770
D 0.091758
E -0.377121
If you pass a function, it must return a value when called with any of the labels (and must produce a set of unique values). But if you pass a dict or Series, it need only contain a subset of the labels as keys:
In [136]: df.rename(columns={'one' : 'foo', 'two' : 'bar'},
.....: index={'a' : 'apple', 'b' : 'banana', 'd' : 'durian'})
.....:
Out[136]:
foo three bar
apple -0.626485 NaN -0.055531
banana -0.644718 0.031723 1.092439
c 1.451071 0.381281 -1.702648
durian NaN 0.728111 -0.097203
The rename method also provides an inplace named parameter that is by default False and copies the underlying data. Pass inplace=True to rename the data in place.
The Panel class has a related rename_axis class which can rename any of its three axes.
Iteration¶
Because Series is array-like, basic iteration produces the values. Other data structures follow the dict-like convention of iterating over the “keys” of the objects. In short:
- Series: values
- DataFrame: column labels
- Panel: item labels
Thus, for example:
In [137]: for col in df:
.....: print col
.....:
one
three
two
iteritems¶
Consistent with the dict-like interface, iteritems iterates through key-value pairs:
- Series: (index, scalar value) pairs
- DataFrame: (column, Series) pairs
- Panel: (item, DataFrame) pairs
For example:
In [138]: for item, frame in wp.iteritems():
.....: print item
.....: print frame
.....:
Item1
A B C D
2000-01-01 0.448167 0.710888 0.647891 -0.319386
2000-01-02 1.247294 -0.796647 0.311735 1.129465
2000-01-03 -0.279719 -0.214164 -0.277303 0.132860
2000-01-04 -1.090723 -0.146198 1.278215 1.019058
2000-01-05 -0.300483 -1.206497 0.980167 -1.151804
Item2
A B C D
2000-01-01 -0.726794 -0.693687 -1.320018 1.482407
2000-01-02 -0.796395 -0.528102 0.361731 0.578976
2000-01-03 -0.501107 -0.427442 -2.052496 -0.118424
2000-01-04 -0.866650 1.071507 1.091661 0.605392
2000-01-05 -1.676946 -0.319358 0.373246 -1.599243
iterrows¶
New in v0.7 is the ability to iterate efficiently through rows of a DataFrame. It returns an iterator yielding each index value along with a Series containing the data in each row:
In [139]: for row_index, row in df2.iterrows():
.....: print '%s\n%s' % (row_index, row)
.....:
a
one -0.686441
two 0.166382
Name: a
b
one -0.704674
two 1.314353
Name: b
c
one 1.391115
two -1.480735
Name: c
For instance, a contrived way to transpose the dataframe would be:
In [140]: df2 = DataFrame({'x': [1, 2, 3], 'y': [4, 5, 6]})
In [141]: print df2
x y
0 1 4
1 2 5
2 3 6
In [142]: print df2.T
0 1 2
x 1 2 3
y 4 5 6
In [143]: df2_t = DataFrame(dict((idx,values) for idx, values in df2.iterrows()))
In [144]: print df2_t
0 1 2
x 1 2 3
y 4 5 6
itertuples¶
This method will return an iterator yielding a tuple for each row in the DataFrame. The first element of the tuple will be the row’s corresponding index value, while the remaining values are the row values proper.
For instance,
In [145]: for r in df2.itertuples(): print r
(0, 1, 4)
(1, 2, 5)
(2, 3, 6)
Vectorized string methods¶
Series is equipped (as of pandas 0.8.1) with a set of string processing methods that make it easy to operate on each element of the array. Perhaps most importantly, these methods exclude missing/NA values automatically. These are accessed via the Series’s str attribute and generally have names matching the equivalent (scalar) build-in string methods:
In [146]: s = Series(['A', 'B', 'C', 'Aaba', 'Baca', np.nan, 'CABA', 'dog', 'cat'])
In [147]: s.str.lower()
Out[147]:
0 a
1 b
2 c
3 aaba
4 baca
5 NaN
6 caba
7 dog
8 cat
In [148]: s.str.upper()
Out[148]:
0 A
1 B
2 C
3 AABA
4 BACA
5 NaN
6 CABA
7 DOG
8 CAT
In [149]: s.str.len()
Out[149]:
0 1
1 1
2 1
3 4
4 4
5 NaN
6 4
7 3
8 3
Methods like split return a Series of lists:
In [150]: s2 = Series(['a_b_c', 'c_d_e', np.nan, 'f_g_h'])
In [151]: s2.str.split('_')
Out[151]:
0 ['a', 'b', 'c']
1 ['c', 'd', 'e']
2 NaN
3 ['f', 'g', 'h']
Elements in the split lists can be accessed using get or [] notation:
In [152]: s2.str.split('_').str.get(1)
Out[152]:
0 b
1 d
2 NaN
3 g
In [153]: s2.str.split('_').str[1]
Out[153]:
0 b
1 d
2 NaN
3 g
Methods like replace and findall take regular expressions, too:
In [154]: s3 = Series(['A', 'B', 'C', 'Aaba', 'Baca',
.....: '', np.nan, 'CABA', 'dog', 'cat'])
.....:
In [155]: s3
Out[155]:
0 A
1 B
2 C
3 Aaba
4 Baca
5
6 NaN
7 CABA
8 dog
9 cat
In [156]: s3.str.replace('^.a|dog', 'XX-XX ', case=False)
Out[156]:
0 A
1 B
2 C
3 XX-XX ba
4 XX-XX ca
5
6 NaN
7 XX-XX BA
8 XX-XX
9 XX-XX t
| Method | Description |
|---|---|
| cat | Concatenate strings |
| split | Split strings on delimiter |
| get | Index into each element (retrieve i-th element) |
| join | Join strings in each element of the Series with passed separator |
| contains | Return boolean array if each string contains pattern/regex |
| replace | Replace occurrences of pattern/regex with some other string |
| repeat | Duplicate values (s.str.repeat(3) equivalent to x * 3) |
| pad | Add whitespace to left, right, or both sides of strings |
| center | Equivalent to pad(side='both') |
| slice | Slice each string in the Series |
| slice_replace | Replace slice in each string with passed value |
| count | Count occurrences of pattern |
| startswith | Equivalent to str.startswith(pat) for each element |
| endswidth | Equivalent to str.endswith(pat) for each element |
| findall | Compute list of all occurrences of pattern/regex for each string |
| match | Call re.match on each element, returning matched groups as list |
| len | Compute string lengths |
| strip | Equivalent to str.strip |
| rstrip | Equivalent to str.rstrip |
| lstrip | Equivalent to str.lstrip |
| lower | Equivalent to str.lower |
| upper | Equivalent to str.upper |
Sorting by index and value¶
There are two obvious kinds of sorting that you may be interested in: sorting by label and sorting by actual values. The primary method for sorting axis labels (indexes) across data structures is the sort_index method.
In [157]: unsorted_df = df.reindex(index=['a', 'd', 'c', 'b'],
.....: columns=['three', 'two', 'one'])
.....:
In [158]: unsorted_df.sort_index()
Out[158]:
three two one
a NaN -0.055531 -0.626485
b 0.031723 1.092439 -0.644718
c 0.381281 -1.702648 1.451071
d 0.728111 -0.097203 NaN
In [159]: unsorted_df.sort_index(ascending=False)
Out[159]:
three two one
d 0.728111 -0.097203 NaN
c 0.381281 -1.702648 1.451071
b 0.031723 1.092439 -0.644718
a NaN -0.055531 -0.626485
In [160]: unsorted_df.sort_index(axis=1)
Out[160]:
one three two
a -0.626485 NaN -0.055531
d NaN 0.728111 -0.097203
c 1.451071 0.381281 -1.702648
b -0.644718 0.031723 1.092439
DataFrame.sort_index can accept an optional by argument for axis=0 which will use an arbitrary vector or a column name of the DataFrame to determine the sort order:
In [161]: df.sort_index(by='two')
Out[161]:
one three two
c 1.451071 0.381281 -1.702648
d NaN 0.728111 -0.097203
a -0.626485 NaN -0.055531
b -0.644718 0.031723 1.092439
The by argument can take a list of column names, e.g.:
In [162]: df = DataFrame({'one':[2,1,1,1],'two':[1,3,2,4],'three':[5,4,3,2]})
In [163]: df[['one', 'two', 'three']].sort_index(by=['one','two'])
Out[163]:
one two three
2 1 2 3
1 1 3 4
3 1 4 2
0 2 1 5
Series has the method order (analogous to R’s order function) which sorts by value, with special treatment of NA values via the na_last argument:
In [164]: s[2] = np.nan
In [165]: s.order()
Out[165]:
0 A
3 Aaba
1 B
4 Baca
6 CABA
8 cat
7 dog
2 NaN
5 NaN
In [166]: s.order(na_last=False)
Out[166]:
2 NaN
5 NaN
0 A
3 Aaba
1 B
4 Baca
6 CABA
8 cat
7 dog
Some other sorting notes / nuances:
- Series.sort sorts a Series by value in-place. This is to provide compatibility with NumPy methods which expect the ndarray.sort behavior.
- DataFrame.sort takes a column argument instead of by. This method will likely be deprecated in a future release in favor of just using sort_index.
Copying, type casting¶
The copy method on pandas objects copies the underlying data (though not the axis indexes, since they are immutable) and returns a new object. Note that it is seldom necessary to copy objects. For example, there are only a handful of ways to alter a DataFrame in-place:
- Inserting, deleting, or modifying a column
- Assigning to the index or columns attributes
- For homogeneous data, directly modifying the values via the values attribute or advanced indexing
To be clear, no pandas methods have the side effect of modifying your data; almost all methods return new objects, leaving the original object untouched. If data is modified, it is because you did so explicitly.
Data can be explicitly cast to a NumPy dtype by using the astype method or alternately passing the dtype keyword argument to the object constructor.
In [167]: df = DataFrame(np.arange(12).reshape((4, 3)))
In [168]: df[0].dtype
Out[168]: dtype('int64')
In [169]: df.astype(float)[0].dtype
Out[169]: dtype('float64')
In [170]: df = DataFrame(np.arange(12).reshape((4, 3)), dtype=float)
In [171]: df[0].dtype
Out[171]: dtype('float64')
Inferring better types for object columns¶
The convert_objects DataFrame method will attempt to convert dtype=object columns to a better NumPy dtype. Occasionally (after transposing multiple times, for example), a mixed-type DataFrame will end up with everything as dtype=object. This method attempts to fix that:
In [172]: df = DataFrame(randn(6, 3), columns=['a', 'b', 'c'])
In [173]: df['d'] = 'foo'
In [174]: df
Out[174]:
a b c d
0 -2.027925 0.494053 1.053982 foo
1 -1.434806 -0.701562 0.758400 foo
2 -1.069966 -0.469855 -0.709164 foo
3 1.716837 -1.577547 -0.590014 foo
4 -0.812681 -0.035205 -1.200505 foo
5 -0.419643 0.247348 -0.835550 foo
In [175]: df = df.T.T
In [176]: df.dtypes
Out[176]:
a object
b object
c object
d object
In [177]: converted = df.convert_objects()
In [178]: converted.dtypes
Out[178]:
a float64
b float64
c float64
d object
Pickling and serialization¶
All pandas objects are equipped with save methods which use Python’s cPickle module to save data structures to disk using the pickle format.
In [179]: df
Out[179]:
a b c d
0 -2.027925 0.4940529 1.053982 foo
1 -1.434806 -0.7015617 0.7584001 foo
2 -1.069966 -0.4698546 -0.7091643 foo
3 1.716837 -1.577547 -0.5900139 foo
4 -0.812681 -0.03520507 -1.200505 foo
5 -0.4196426 0.2473478 -0.83555 foo
In [180]: df.save('foo.pickle')
The load function in the pandas namespace can be used to load any pickled pandas object (or any other pickled object) from file:
In [181]: load('foo.pickle')
Out[181]:
a b c d
0 -2.027925 0.4940529 1.053982 foo
1 -1.434806 -0.7015617 0.7584001 foo
2 -1.069966 -0.4698546 -0.7091643 foo
3 1.716837 -1.577547 -0.5900139 foo
4 -0.812681 -0.03520507 -1.200505 foo
5 -0.4196426 0.2473478 -0.83555 foo
There is also a save function which takes any object as its first argument:
In [182]: save(df, 'foo.pickle')
In [183]: load('foo.pickle')
Out[183]:
a b c d
0 -2.027925 0.4940529 1.053982 foo
1 -1.434806 -0.7015617 0.7584001 foo
2 -1.069966 -0.4698546 -0.7091643 foo
3 1.716837 -1.577547 -0.5900139 foo
4 -0.812681 -0.03520507 -1.200505 foo
5 -0.4196426 0.2473478 -0.83555 foo
Console Output Formatting¶
Use the set_eng_float_format function in the pandas.core.common module to alter the floating-point formatting of pandas objects to produce a particular format.
For instance:
In [184]: set_eng_float_format(accuracy=3, use_eng_prefix=True)
In [185]: df['a']/1.e3
Out[185]:
0 -2.028m
1 -1.435m
2 -1.070m
3 1.717m
4 -812.681u
5 -419.643u
Name: a
In [186]: df['a']/1.e6
Out[186]:
0 -2.028u
1 -1.435u
2 -1.070u
3 1.717u
4 -812.681n
5 -419.643n
Name: a
The set_printoptions function has a number of options for controlling how floating point numbers are formatted (using hte precision argument) in the console and . The max_rows and max_columns control how many rows and columns of DataFrame objects are shown by default. If max_columns is set to 0 (the default, in fact), the library will attempt to fit the DataFrame’s string representation into the current terminal width, and defaulting to the summary view otherwise.