Skip to content

Commit 4404d39

Browse files
committed
DOC: better to_xarray doc-string
1 parent e78c61f commit 4404d39

File tree

1 file changed

+38
-15
lines changed

1 file changed

+38
-15
lines changed

pandas/core/generic.py

+38-15
Original file line numberDiff line numberDiff line change
@@ -1052,7 +1052,15 @@ def to_xarray(self):
10521052
10531053
Examples
10541054
--------
1055-
>>> df = DataFrame({'A' : [1, 2, 3], 'B' : ['foo', 'bar', 'baz']})
1055+
>>> df = pd.DataFrame({'A' : [1, 2, 3],
1056+
'B' : ['foo', 'bar', 'baz'],
1057+
'C' : np.arange(4.,7)})
1058+
>>> df
1059+
A B C
1060+
0 1 foo 4.0
1061+
1 2 bar 5.0
1062+
2 3 baz 6.0
1063+
10561064
>>> df.to_xarray()
10571065
<xarray.Dataset>
10581066
Dimensions: (index: 3)
@@ -1061,26 +1069,41 @@ def to_xarray(self):
10611069
Data variables:
10621070
A (index) int64 1 2 3
10631071
B (index) object 'foo' 'bar' 'baz'
1072+
C (index) float64 4.0 5.0 6.0
1073+
1074+
>>> p = pd.Panel(np.arange(24).reshape(4,3,2),
1075+
items=list('ABCD'),
1076+
major_axis=pd.date_range('20130101', periods=3),
1077+
minor_axis=['first', 'second'])
1078+
>>> p
1079+
<class 'pandas.core.panel.Panel'>
1080+
Dimensions: 4 (items) x 3 (major_axis) x 2 (minor_axis)
1081+
Items axis: A to D
1082+
Major_axis axis: 2013-01-01 00:00:00 to 2013-01-03 00:00:00
1083+
Minor_axis axis: first to second
10641084
1065-
>>> p = pd.Panel(np.arange(6).reshape(3,2,1))
10661085
>>> p.to_xarray()
1067-
<xarray.DataArray (items: 3, major_axis: 2, minor_axis: 1)>
1068-
array([[[0],
1069-
[1]],
1070-
1071-
[[2],
1072-
[3]],
1073-
1074-
[[4],
1075-
[5]]])
1086+
<xarray.DataArray (items: 4, major_axis: 3, minor_axis: 2)>
1087+
array([[[ 0, 1],
1088+
[ 2, 3],
1089+
[ 4, 5]],
1090+
[[ 6, 7],
1091+
[ 8, 9],
1092+
[10, 11]],
1093+
[[12, 13],
1094+
[14, 15],
1095+
[16, 17]],
1096+
[[18, 19],
1097+
[20, 21],
1098+
[22, 23]]])
10761099
Coordinates:
1077-
* items (items) int64 0 1 2
1078-
* major_axis (major_axis) int64 0 1
1079-
* minor_axis (minor_axis) int64 0
1100+
* items (items) object 'A' 'B' 'C' 'D'
1101+
* major_axis (major_axis) datetime64[ns] 2013-01-01 2013-01-02 2013-01-03 # noqa
1102+
* minor_axis (minor_axis) object 'first' 'second'
10801103
10811104
Notes
10821105
-----
1083-
See also the `xarray docs <http://xarray.pydata.org/en/stable/>`__
1106+
See the `xarray docs <http://xarray.pydata.org/en/stable/>`__
10841107
"""
10851108
import xarray
10861109
if self.ndim == 1:

0 commit comments

Comments
 (0)