pandas.DataFrame.to_latex¶
-
DataFrame.
to_latex
(buf=None, columns=None, col_space=None, header=True, index=True, na_rep='NaN', formatters=None, float_format=None, sparsify=None, index_names=True, bold_rows=True, column_format=None, longtable=None, escape=None, encoding=None, decimal='.')[source]¶ Render a DataFrame to a tabular environment table. You can splice this into a LaTeX document. Requires usepackage{booktabs}.
to_latex-specific options:
- bold_rows : boolean, default True
- Make the row labels bold in the output
- column_format : str, default None
- The columns format as specified in LaTeX table format e.g ‘rcl’ for 3 columns
- longtable : boolean, default will be read from the pandas config module
- default: False Use a longtable environment instead of tabular. Requires adding a usepackage{longtable} to your LaTeX preamble.
- escape : boolean, default will be read from the pandas config module
- default: True When set to False prevents from escaping latex special characters in column names.
- encoding : str, default None
- A string representing the encoding to use in the output file, defaults to ‘ascii’ on Python 2 and ‘utf-8’ on Python 3.
- decimal : string, default ‘.’
Character recognized as decimal separator, e.g. ‘,’ in Europe
New in version 0.18.0.
Parameters: buf : StringIO-like, optional
buffer to write to
columns : sequence, optional
the subset of columns to write; default None writes all columns
col_space : int, optional
the minimum width of each column
header : bool, optional
whether to print column labels, default True
index : bool, optional
whether to print index (row) labels, default True
na_rep : string, optional
string representation of NAN to use, default ‘NaN’
formatters : list or dict of one-parameter functions, optional
formatter functions to apply to columns’ elements by position or name, default None. The result of each function must be a unicode string. List must be of length equal to the number of columns.
float_format : one-parameter function, optional
formatter function to apply to columns’ elements if they are floats, default None. The result of this function must be a unicode string.
sparsify : bool, optional
Set to False for a DataFrame with a hierarchical index to print every multiindex key at each row, default True
index_names : bool, optional
Prints the names of the indexes, default True
line_width : int, optional
Width to wrap a line in characters, default no wrap
Returns: formatted : string (or unicode, depending on data and options)