Skip to content

Commit ef0906b

Browse files
committed
Updated examples
1 parent a0ca4d7 commit ef0906b

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

pandas/core/frame.py

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1846,12 +1846,15 @@ def to_stata(self, fname, convert_dates=None, write_index=True,
18461846
data_label=None, variable_labels=None, version=114,
18471847
convert_strl=None):
18481848
"""
1849-
Export Stata binary dta files.
1849+
Converting data frame object to Stata dta format.
1850+
1851+
Writes the Dataframe to a Stata dataset file.
1852+
"dta" files contain a Stata dataset.
18501853
18511854
Parameters
18521855
----------
18531856
fname : path (string), buffer or path object
1854-
string, path object (pathlib.Path or py._path.local.LocalPath) or
1857+
String, path object (pathlib.Path or py._path.local.LocalPath) or
18551858
object implementing a binary write() functions. If using a buffer
18561859
then the buffer will not be automatically closed after the file
18571860
data has been written.
@@ -1911,26 +1914,27 @@ def to_stata(self, fname, convert_dates=None, write_index=True,
19111914
19121915
See Also
19131916
--------
1914-
pandas.read_stata : Import Stata data files
1915-
pandas.io.stata.StataWriter : low-level writer for Stata data files
1916-
pandas.io.stata.StataWriter117 : low-level writer for version 117 files
1917+
pandas.read_stata : Import Stata data files.
1918+
pandas.io.stata.StataWriter : Writer for Stata data files.
1919+
pandas.io.stata.StataWriter117 : Writer for version 117 files.
19171920
19181921
Examples
19191922
--------
1920-
>>> data.to_stata('./data_file.dta')
1921-
1922-
Or with dates
1923+
Converting dataframe with date column to Stata dta file
1924+
using the to_stata method.
19231925
1924-
>>> data.to_stata('./date_data_file.dta', {2 : 'tw'})
1926+
>>> dates = pd.date_range(start='2018-01-01', periods=4)
1927+
>>> df = pd.DataFrame({'date': dates,
1928+
... 'animal': ['falcon', 'parrot', 'falcon',
1929+
... 'parrot'],
1930+
... 'speed': [350, 18, 361, 15]}).set_index(['date',
1931+
... 'animal'])
1932+
>>> df.to_stata('animals.dta')
19251933
19261934
Alternatively you can create an instance of the StataWriter class
19271935
1928-
>>> writer = StataWriter('./data_file.dta', data)
1929-
>>> writer.write_file()
1930-
1931-
With dates:
1932-
1933-
>>> writer = StataWriter('./date_data_file.dta', data, {2 : 'tw'})
1936+
>>> StataWriter = pd.io.stata.StataWriter
1937+
>>> writer = StataWriter('animals.dta', df)
19341938
>>> writer.write_file()
19351939
"""
19361940
kwargs = {}

0 commit comments

Comments
 (0)