texreg: get_stars_note – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

texreg

get_stars_note

Create a legend for the stars in a regression table

Description

Create a legend for the stars in a regression table.

Usage

get_stars_note(
  stars = c(0.01, 0.05, 0.1),
  star.symbol = "*",
  symbol = ".",
  ci = FALSE,
  ci.test = NULL,
  output = "ascii"
)

Arguments

`stars`	A numeric vector of cut-offs, with a maximum of four numbers.
`star.symbol`	The character to repeat for the first three levels of significance.
`symbol`	The character for the fourth level of significance.
`ci`	Confidence intervals instead of standard errors?
`ci.test`	The null hypothesis value, for example `0` (the normal case) or `1` (e.g., with exponentiated coefficients). A star is added if this value is outside the confidence interval.
`output`	The output type of the note. This can be `"ascii"`, `"latex"`, or `"html"`.

Details

This function creates a stars note as a legend to be placed below a regression table. The note contains the p-value or confidence interval significance levels and stars attached to them.

Value

A character string to be put below the regression table. It describes the thresholds for the significance stars.

Author(s)

Philip Leifeld