tidystats (version 0.3)

add_stats.matrix: add_stats matrix function

Description

add_stats.matrix is a function to add a matrix to a tidystats list. Some statistical functions (e.g., confint) return a matrix. Normally this would not be enough information for tidystats to figure out how to tidy the results. However, if you run add_stats and provide a class, tidystats may be able to tidy the output. See 'Details' for a list of supported classes.

Usage

# S3 method for matrix
add_stats(results, output, identifier = NULL,
  type = NULL, confirmatory = NULL, notes = NULL, class = NULL)

Arguments

results

A tidystats list.

output

A matrix that contains statistical output.

identifier

A character string identifying the model. Automatically created if not provided.

type

A character string indicating the type of test. One of "hypothesis", "manipulation check", "contrast", "descriptives", or "other". Can be abbreviated.

confirmatory

A boolean to indicate whether the statistical test was confirmatory (TRUE) or exploratory (FALSE). Can be NA.

notes

A character string to add additional information. Some statistical tests produce notes information, which will be overwritten if notes are provided.

class

A character string to indicate which function was used to produce the output. See 'Details' for a list of supported functions.

Details

Supported classes include: confint

Examples

# NOT RUN {
# Create an empty list to store the results in
results <- list()

# Example: Confidence intervals on a regression model
ctl <- c(4.17,5.58,5.18,6.11,4.50,4.61,5.17,4.53,5.33,5.14)
trt <- c(4.81,4.17,4.41,3.59,5.87,3.83,6.03,4.89,4.32,4.69)
group <- gl(2, 10, 20, labels = c("Ctl","Trt"))
weight <- c(ctl, trt)

model_lm <- lm(weight ~ group)
model_lm_confint <- confint(model_lm)

# Add output to the results list
results <- add_stats(results, model_lm_confint, identifier = "lm_confint",
  class = "confint")

# }