specr (version 1.0.0)

summary.specr.setup: Summarizing the Specifications Setup

Description

summary method for class "specr.setup". Provides a short summary of the created specifications (the "multiverse") that lists all analytic choices, prints the function used to extract the parameters from the model. Finally, if print.specs = TRUE, it also shows the head of the actual specification grid.

Usage

# S3 method for specr.setup
summary(object, digits = 2, rows = 6, print.specs = TRUE, ...)

Value

A printed summary of an object of class specr.setup.

Arguments

object

An object of class "specr.setup", usually, a result of a call to setup.

digits

The number of digits to use when printing the specification table.

rows

The number of rows of the specification tibble that should be printed.

print.specs

Logical value; if TRUE, a head of the specification tibble is returned and printed.

...

further arguments passed to or from other methods (currently ignored).

See Also

The function setup(), which creates the "specr.setup" object.

Examples

# Setup specifications
specs <- setup(data = example_data,
  x = c("x1", "x2"),
  y = c("y1", "y2"),
  model = c("lm", "glm"),
  controls = c("c1", "c2", "c3"),
  subsets = list(group3 = unique(example_data$group3)))

# Summarize specifications
summary(specs)