linearmodels.compat.statsmodels.Summary¶

class linearmodels.compat.statsmodels.Summary[source]¶

Summary of the estimation results of a model.

The summary contains tables of results and notes below the tables. It is returned by the summary property of the results. It can be converted to text, HTML, LaTeX and CSV using as_text, as_html, as_latex and as_csv.

tables¶

The tables of the summary.

Type:¶: list

extra_txt¶

The notes that are written below the tables in every format, with one line of the notes on each line of the string. Set it to None to remove the notes from as_text, as_html, as_latex and as_csv, or to a string to replace them. add_extra_txt replaces the notes with the lines of text that it is given.

Type:¶: str or None

Notes

The summary property of the results creates a new summary each time that it is used. Keep the summary in a variable before changing extra_txt.

Examples

Export the tables without the notes

>>> smry = res.summary
>>> smry.extra_txt = None
>>> latex = smry.as_latex()

Methods

`add_extra_txt`(etext)	Add additional text that will be added at the end in text format
`add_table_2cols`(res[, title, gleft, gright, ...])	Add a double table, 2 tables with one column merged horizontally
`add_table_params`(res[, yname, xname, alpha, ...])	Create and add a table for the parameter estimates
`as_csv`()	Return tables as string
`as_html`()	Return the tables as a string in HTML format.
`as_latex`()	Return the tables as a string in LaTeX format.
`as_text`()	Return tables as string