x |
The trial design plan, obtained from
getSampleSizeMeans(),
getSampleSizeRates(),
getSampleSizeSurvival(),
getSampleSizeCounts(),
getPowerMeans(),
getPowerRates() or
getPowerSurvival() or
getPowerCounts().
|
y |
Not available for this kind of plot (is only defined to be compatible to the generic plot function).
|
... |
Optional plot arguments. At the moment xlim and ylim are implemented
for changing x or y axis limits without dropping data observations.
|
main |
The main title.
|
xlab |
The x-axis label.
|
ylab |
The y-axis label.
|
type |
The plot type (default = 1). The following plot types are available:
-
1: creates a 'Boundaries' plot
-
2: creates a 'Boundaries Effect Scale' plot
-
3: creates a 'Boundaries p Values Scale' plot
-
4: creates a 'Error Spending' plot
-
5: creates a 'Sample Size' or 'Overall Power and Early Stopping' plot
-
6: creates a 'Number of Events' or 'Sample Size' plot
-
7: creates an 'Overall Power' plot
-
8: creates an 'Overall Early Stopping' plot
-
9: creates an 'Expected Number of Events' or 'Expected Sample Size' plot
-
10: creates a 'Study Duration' plot
-
11: creates an 'Expected Number of Subjects' plot
-
12: creates an 'Analysis Times' plot
-
13: creates a 'Cumulative Distribution Function' plot
-
14: creates a 'Survival Function' plot
-
"all": creates all available plots and returns it as a grid plot or list
|
palette |
The palette, default is "Set1".
|
theta |
A vector of standardized effect sizes (theta values), default is a sequence from -1 to 1.
|
plotPointsEnabled |
Logical. If TRUE, additional points will be plotted.
|
legendPosition |
The position of the legend.
By default (NA_integer_) the algorithm tries to find a suitable position.
Choose one of the following values to specify the position manually:
-
-1: no legend will be shown
-
NA: the algorithm tries to find a suitable position
-
0: legend position outside plot
-
1: legend position left top
-
2: legend position left center
-
3: legend position left bottom
-
4: legend position right top
-
5: legend position right center
-
6: legend position right bottom
|
showSource |
Logical. If TRUE, the parameter names of the object will
be printed which were used to create the plot; that may be, e.g.,
useful to check the values or to create own plots with the base R plot function.
Alternatively showSource can be defined as one of the following character values:
-
"commands": returns a character vector with plot commands
-
"axes": returns a list with the axes definitions
-
"test": all plot commands will be validated with eval(parse()) and
returned as character vector (function does not stop if an error occurs)
-
"validate": all plot commands will be validated with eval(parse()) and
returned as character vector (function stops if an error occurs)
Note: no plot object will be returned if showSource is a character.
|
grid |
An integer value specifying the output of multiple plots.
By default (1) a list of ggplot objects will be returned.
If a grid value > 1 was specified, a grid plot will be returned
if the number of plots is <= specified grid value;
a list of ggplot objects will be returned otherwise.
If grid = 0 is specified, all plots will be created using print command
and a list of ggplot objects will be returned invisible.
Note that one of the following packages must be installed to create a grid plot:
'ggpubr', 'gridExtra', or 'cowplot'.
|
plotSettings |
An object of class PlotSettings created by getPlotSettings().
|