Pandas DataFrame: to_latex() function
DataFrame - to_latex() function
The to_latex() function is used to render an object to a LaTeX tabular environment table.
Syntax:
DataFrame.to_latex(self, 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=False, column_format=None, longtable=None, escape=None, encoding=None, decimal='.', multicolumn=None, multicolumn_format=None, multirow=None)
Parameters:
| Name | Description | Type/Default Value | Required / Optional |
|---|---|---|---|
| buf | Buffer to write to. If None, the output is returned as a string. | file descriptor or None | Required |
| columns | The subset of columns to write. Writes all columns by default. | list of label | Optional |
| col_space | The minimum width of each column. | int | Optional |
| header | Write out the column names. If a list of strings is given, it is assumed to be aliases for the column names. | bool or list of str Default Value: True |
Required |
| index | Write row names (index). | bool Default Value: True |
Required |
| na_rep | Missing data representation. | str Default Value: ‘NaN’ |
Required |
| formatters | Formatter functions to apply to columns’ elements by position or name. The result of each function must be a unicode string. List must be of length equal to the number of columns. | list of functions or dict of {str: function} | Optional |
| float_format | Formatter for floating point numbers. For example float_format="%%.2f" and float_format="{:0.2f}".format will both result in 0.1234 being formatted as 0.12. | one-parameter function or str, Default Value: None |
Optional |
| sparsify | Set to False for a DataFrame with a hierarchical index to print every multiindex key at each row. By default, the value will be read from the config module. | bool | Optional |
| index_names | Prints the names of the indexes. | bool Default Value: True |
Required |
| bold_rows | Make the row labels bold in the output. | bool Default Value: False |
Required |
| column_format | The columns format as specified in LaTeX table format e.g. 'rcl' for 3 columns. By default, 'l' will be used for all columns except columns of numbers, which default to 'r'. | str | Optional |
| longtable | By default, the value will be read from the pandas config module. Use a longtable environment instead of tabular. Requires adding a usepackage{longtable} to your LaTeX preamble. | bool |
Optional |
| escape | By default, the value will be read from the pandas config module. When set to False prevents from escaping latex special characters in column names. | bool |
Optional |
| encoding | A string representing the encoding to use in the output file, defaults to 'utf-8’. | str |
Required |
| decimal | Character recognized as decimal separator, e.g. ',' in Europe. | str Default Value: '.' |
Required |
| multicolumn | Use multicolumn to enhance MultiIndex columns. The default will be read from the config module. | bool Default Value: True |
Required |
| multicolumn_format | The alignment for multicolumns, similar to column_format The default will be read from the config module. | str Default Value: 'l' |
Required |
| multirow | Use multirow to enhance MultiIndex rows. Requires adding a usepackage{multirow} to your LaTeX preamble. Will print centered labels (instead of top-aligned) across the contained rows, separating groups via clines. The default will be read from the pandas config module. | bool Default Value: False |
Required |
Returns: str or None
If buf is None, returns the resulting LateX format as a string. Otherwise returns None.
Example:
Download the Pandas DataFrame Notebooks from here.
Previous: DataFrame - to_json() function
Next: DataFrame - to_stata() function