getAvailablePlotTypes: Get Available Plot Types

In rpact: Confirmatory Adaptive Clinical Trial Design and Analysis

Get Available Plot Types

Description

Function to identify the available plot types of an object.

Usage

plotTypes(
  obj,
  output = c("numeric", "caption", "numcap", "capnum"),
  numberInCaptionEnabled = FALSE
)

getAvailablePlotTypes(
  obj,
  output = c("numeric", "caption", "numcap", "capnum"),
  numberInCaptionEnabled = FALSE
)

Arguments

obj	The object for which the plot types shall be identified, e.g. produced by getDesignGroupSequential() or getSampleSizeMeans().
output	The output type. Can be one of c("numeric", "caption", "numcap", "capnum").
numberInCaptionEnabled	If TRUE, the number will be added to the caption, default is FALSE.

Details

plotTypes and getAvailablePlotTypes() are equivalent, i.e., plotTypes is a short form of getAvailablePlotTypes().

output:

1. numeric: numeric output

2. caption: caption as character output

3. numcap: list with number and caption

4. capnum: list with caption and number

Value

Returns a list if option is either capnum or numcap or returns a vector that is of character type for option=caption or of numeric type for option=numeric.

Examples

## Not run: 
design <- getDesignInverseNormal(kMax = 2)
getAvailablePlotTypes(design, "numeric")
plotTypes(design, "caption")
getAvailablePlotTypes(design, "numcap")
plotTypes(design, "capnum")

## End(Not run)

rpact documentation built on Aug. 12, 2025, 1:06 a.m.