rpact (version 3.2.1)

plotTypes: 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.

Value

Depending on how the output is specified, a numeric vector, a character vector, or a list will be returned.

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

Examples

# NOT RUN {
design <- getDesignInverseNormal(kMax = 2)
getAvailablePlotTypes(design, "numeric")
plotTypes(design, "caption")
getAvailablePlotTypes(design, "numcap")
plotTypes(design, "capnum")

# }