plot.Method: Plot the results of a sample size analysis

Description Usage Arguments Value See Also

View source: R/Method.R

Description

This function plots the results for each step of the method.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## S3 method for class 'Method'
plot(
  x,
  step = 3,
  last = TRUE,
  save = FALSE,
  path = NULL,
  width = 14,
  height = 10,
  ...
)

Arguments

x

An object instance of class Method.

step

A single positive integer representing the method step that should be plotted. Possibles values are 1 for the first step, 2 for the second step, and 3 for the third step of the method.

last

A logical value indicating whether the last iteration of the method should be plotted. The default is TRUE, indicating that the last iteration should be plotted.

save

A logical value indicating whether the plot should be saved to a file on disk.

path

A character string representing the path (i.e., including the filename and extension) where the plot should be saved on disk. If NULL, the plot will be saved in the current working directory with a filename generated based on the current system time and a .pdf extension. See ggplot2::ggsave() for supported file types.

width

A single numerical value representing the desired plot width. The default unit is inches (i.e., set by ggplot2::ggsave()), unless overridden by providing the units argument via ....

height

A single numerical value representing the desired plot height. The default unit is inches (i.e., set by ggplot2::ggsave()), unless overridden by providing the units argument via ....

...

Optional arguments to be passed to ggplot2::ggsave().

Value

An ggplot2::ggplot object containing the plot for the requested step of the method. The plot object returned can be further modified and also contains the patchwork class applied.

Example of a plot for each step of the method:

Step 1: Monte Carlo Replications

Example Step 1

Step 2: Curve Fitting

Example Step 2

Step 3: Bootstrapping

Example Step 3

See Also

summary.Method(), powerly()


powerly documentation built on Nov. 17, 2021, 5:07 p.m.