wrapFTest.data.frame: Wrap quality statistic of identity relation from data.

In sigr: Succinct and Correct Statistical Summaries for Reports

Wrap quality statistic of identity relation from data.

Description

Wrap quality statistic of identity relation from data.

Usage

## S3 method for class 'data.frame'
wrapFTest(
  x,
  predictionColumnName,
  yColumnName,
  nParameters = 1,
  meany = mean(x[[yColumnName]]),
  ...,
  na.rm = FALSE,
  format = NULL
)

Arguments

x	data frame containing columns to compare
predictionColumnName	character name of prediction column
yColumnName	character name of column containing dependent variable
nParameters	number of variables in model
meany	(optional) mean of y
...	extra arguments (not used)
na.rm	logical, if TRUE remove NA values
format	if set the format to return ("html", "latex", "markdown", "ascii", "docx")

Value

formatted string and fields

Examples

d <- data.frame(x=c(1,2,3,4,5,6,7,7),
                y=c(1,1,2,2,3,3,4,4))
model <- lm(y~x,data=d)
summary(model)
d$pred <- predict(model,newdata=d)
sigr::wrapFTest(d,'pred','y')

sigr documentation built on Aug. 20, 2023, 9:06 a.m.