Skip to contents

Plot visualization of the specification setup

Source: R/generics.r
plot.specr.setup.Rd

This function plots a visual summary of the specification setup. It requires an object of class specr.setup, usually the result of calling setup().

Usage

# S3 method for class 'specr.setup'
plot(x, layout = "dendrogram", circular = FALSE, ...)

Arguments

x

A specr.setup object, usually resulting from calling setup().

layout

The type of layout to create for the garden of forking path. Defaults to "dendrogram". See ?ggraph for options.

circular

Should the layout be transformed into a radial representation. Only possible for some layouts. Defaults to FALSE.

...

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

Value

A ggplot object that can be customized further.

Examples

# \donttest{
specs <- setup(data = example_data,
   x = c("x1", "x2", "x3"),
   y = c("y1", "y2"),
   model = c("lm", "glm"),
   controls = "c1",
   subsets = list(group2 = unique(example_data$group2)))

plot(specs)

plot(specs, circular = TRUE)

# }