report_estimate: Format Estimated Coefficients for Reporting

In NicolasJBM/fmtR: Toolbox to format and report numbers

Description

Format in-text the reporting of confidence intervals or p-values around an estimate.

Usage

report_estimate(
  symbol = "$\beta$",
  estimate = NULL,
  std_error = NULL,
  threshold = 0.05,
  digits = 3,
  statistics = c("cf", "ci", "pv")
)

Arguments

symbol	Character. Name or identifier of the coefficient.
estimate	Numeric. Estimate of the coefficient.
std_error	Numeric. Standard error around the estimate.
threshold	Numeric. Probability of 0 contained in the confidence interval (e.g. 0.05 for a 95% confidence interval).
digits	Integer. Number of digits for rounding.
statistics	Character vector. Statistics to report: "cf" for the coefficient, "ci" for the confidence internal, "pv" for the p-value.

Value

Character with specified statistics between parentheses.

Author(s)

Nicolas Mangin

NicolasJBM/fmtR documentation built on Dec. 31, 2020, 3:21 p.m.