Skip to content

Commit 0bebcb1

Browse files
committed
Updated examples
1 parent 28a42da commit 0bebcb1

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

pandas/core/frame.py

+19-15
Original file line numberDiff line numberDiff line change
@@ -1849,12 +1849,15 @@ def to_stata(self, fname, convert_dates=None, write_index=True,
18491849
data_label=None, variable_labels=None, version=114,
18501850
convert_strl=None):
18511851
"""
1852-
Export Stata binary dta files.
1852+
Converting data frame object to Stata dta format.
1853+
1854+
Writes the Dataframe to a Stata dataset file.
1855+
"dta" files contain a Stata dataset.
18531856
18541857
Parameters
18551858
----------
18561859
fname : path (string), buffer or path object
1857-
string, path object (pathlib.Path or py._path.local.LocalPath) or
1860+
String, path object (pathlib.Path or py._path.local.LocalPath) or
18581861
object implementing a binary write() functions. If using a buffer
18591862
then the buffer will not be automatically closed after the file
18601863
data has been written.
@@ -1914,26 +1917,27 @@ def to_stata(self, fname, convert_dates=None, write_index=True,
19141917
19151918
See Also
19161919
--------
1917-
pandas.read_stata : Import Stata data files
1918-
pandas.io.stata.StataWriter : low-level writer for Stata data files
1919-
pandas.io.stata.StataWriter117 : low-level writer for version 117 files
1920+
pandas.read_stata : Import Stata data files.
1921+
pandas.io.stata.StataWriter : Writer for Stata data files.
1922+
pandas.io.stata.StataWriter117 : Writer for version 117 files.
19201923
19211924
Examples
19221925
--------
1923-
>>> data.to_stata('./data_file.dta')
1924-
1925-
Or with dates
1926+
Converting dataframe with date column to Stata dta file
1927+
using the to_stata method.
19261928
1927-
>>> data.to_stata('./date_data_file.dta', {2 : 'tw'})
1929+
>>> dates = pd.date_range(start='2018-01-01', periods=4)
1930+
>>> df = pd.DataFrame({'date': dates,
1931+
... 'animal': ['falcon', 'parrot', 'falcon',
1932+
... 'parrot'],
1933+
... 'speed': [350, 18, 361, 15]}).set_index(['date',
1934+
... 'animal'])
1935+
>>> df.to_stata('animals.dta')
19281936
19291937
Alternatively you can create an instance of the StataWriter class
19301938
1931-
>>> writer = StataWriter('./data_file.dta', data)
1932-
>>> writer.write_file()
1933-
1934-
With dates:
1935-
1936-
>>> writer = StataWriter('./date_data_file.dta', data, {2 : 'tw'})
1939+
>>> StataWriter = pd.io.stata.StataWriter
1940+
>>> writer = StataWriter('animals.dta', df)
19371941
>>> writer.write_file()
19381942
"""
19391943
kwargs = {}

0 commit comments

Comments
 (0)