render.sigr_significance: Format a significance

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

Format a significance

Description

Format a significance

Usage

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

Arguments

statistic	wrapped significance
...	not used, force use of named binding for later arguments
format	if set the format to return ("html", "latex", "markdown", "ascii")
statDigits	integer number of digits to show in summaries (not used in significance reports).
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

cat(render(wrapSignificance(1/300),format='html'))

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