plot_simrel: A wrapper function for a simrel object

Description Usage Arguments Value Examples

View source: R/plotting-functions.R

Description

A wrapper function for a simrel object

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
plot_simrel(
  obj,
  ncomp = min(obj$p, obj$n, 20),
  which = c(1L:4L),
  layout = NULL,
  print.cov = FALSE,
  use_population = TRUE,
  palette = "Set1",
  base_theme = ggplot2::theme_grey,
  lab_list = NULL,
  theme_list = NULL
)

Arguments

obj

A simrel object

ncomp

Number of components to show in x-axis

which

An integer specifying which simrel plot to obtain

layout

A layout matrix for arranging the simrel plots

print.cov

A boolean where to print covariance matrices

use_population

A boolean specifying weather to get plot for population or sample

palette

Name of color paletter compaticable with RColorBrewer

base_theme

Base ggplot theme to apply

lab_list

List of labs arguments such as x, y, title, subtitle. A nested list if the argument which has length greater than 1.

theme_list

List of theme arguments to apply in the plot. A nested list if the argument which has length greater than 1.

Value

Simrel Plot(s)

Examples

1
2
sobj <- bisimrel(p = 12)
plot_simrel(sobj, layout = matrix(1:4, 2, 2))

simulatr/simrel documentation built on Sept. 15, 2021, 12:44 a.m.