render.sigr_tinterval: Format a Student-T tolerance-style interval around an...

In WinVector/sigr: Succinct and Correct Statistical Summaries for Reports

Format a Student-T tolerance-style interval around an estimate of a mean.

Description

Report sample size (n), sample mean, bias-corrected standard deviation estimate (assuming normality, using a chi-square distribution correction from https://en.wikipedia.org/wiki/Unbiased_estimation_of_standard_deviation#Bias_correction), and a Student t-test tolerance-style confidence interval.

Usage

## S3 method for class 'sigr_tinterval'
render(
  statistic,
  ...,
  format,
  statDigits = 4,
  sigDigits = 4,
  pLargeCutoff = 0.05,
  pSmallCutoff = 1e-05
)

Arguments

statistic	wrapped TInterval.
...	extra arguments (not used)
format	if set the format to return ("html", "latex", "markdown", "ascii", "docx", ...)
statDigits	integer number of digits to show in summaries.
sigDigits	integer number of digits to show in significances.
pLargeCutoff	value to declare non-significance at or above.
pSmallCutoff	smallest value to print

Value

formatted string

Examples

set.seed(2018)
d <- rnorm(100) + 3.2
TInterval(d)

WinVector/sigr documentation built on Aug. 29, 2023, 3:57 a.m.