PlotOSA {aides}

Illustrate observed sequential plot.

Description

PlotOSA() is a function for plotting observed sequential analysis.

Usage

PlotOSA(
  object = NULL,
  sclAxsX = "sample",
  txtTtl = NULL,
  group = NULL,
  lgcZone = FALSE,
  lgcLblStdy = FALSE,
  lgcSAP = FALSE,
  lgcInvert = FALSE,
  lgcSmooth = FALSE,
  szFntTtl = 1.8,
  szFntTtlX = 1.2,
  szFntTtlY = NULL,
  szFntAxsX = 0.8,
  szFntAxsY = 0.8,
  szFntLgnd = 0.7,
  szFntLblY = 1.2,
  szFntStdy = 0.8,
  szFntOIS = 0.8,
  szFntAIS = 0.8,
  szPntStdy = 1,
  szPntASB = 0.8,
  szLn0 = 1,
  szLnSig = 1,
  szLnZCum = 2,
  szLnASB = 1,
  szLnOIS = 1,
  typPntStdy = NULL,
  typPntASB = NULL,
  typLn0 = 1,
  typLnSig = 2,
  typLnZCum = 1,
  typLnASB = 3,
  typLnOIS = 2,
  clrTtl = "black",
  clrTtlX = "black",
  clrTtlY = "black",
  clrAxsX = "black",
  clrAxsY = "black",
  clrLgnd = "black",
  clrLblY = "black",
  clrLblStdy = "black",
  clrLblOIS = "black",
  clrLblAIS = "black",
  clrPntStdy = "gray25",
  clrPntASB = "none",
  clrLn0 = "gray25",
  clrLnSig = "gray",
  clrLnZCum = "blue4",
  clrLnASB = "red4",
  clrLnOIS = "red4",
  anglStdy = 30,
  BSB = FALSE
)

Arguments

object

OBJECT in DoOSA class that is an output of observed sequential analysis using function DoOSA().

sclAxsX

CHARACTER for indicating unit of scale on axis X.

txtTtl

CHARACTER for user-defined main title on the observed sequential analysis plot.

group

CHARACTER for labeling two groups.

lgcZone

LOGIC value for indicating whether to show zones.

lgcLblStdy

LOGIC value for indicating whether to label each data source.

lgcSAP

LOGIC value for indicating whether to show sequential-adjusted power.

lgcInvert

LOGIC value for indicating whether to invert plot.

lgcSmooth

LOGIC value for indicating whether to smooth error boundaries.

szFntTtl

NUMERIC value for indicating font size of main title.

szFntTtlX

NUMERIC value for indicating font size of title on axis X.

szFntTtlY

NUMERIC value for indicating font size of title on axis Y.

szFntAxsX

NUMERIC value for indicating font size of scale on axis X.

szFntAxsY

NUMERIC value for indicating font size of scale on axis Y.

szFntLgnd

NUMERIC value for indicating font size of legend.

szFntLblY

NUMERIC value for indicating font size of the label of "Cumulative z-score" on axis Y.

szFntStdy

NUMERIC value(s) for indicating font size(s) of the label(s) of each data source.

szFntOIS

NUMERIC value for indicating font size of the label of optimal information size.

szFntAIS

NUMERIC value for indicating font size of the label of acquired information size.

szPntStdy

NUMERIC value(s) for indicating size(s) of observed point(s).

szPntASB

NUMERIC value for indicating size of point(s) on alpha-spending boundaries.

szLn0

NUMERIC value for indicating width of null line.

szLnSig

NUMERIC value for indicating width of line for statistical significance.

szLnZCum

NUMERIC value for indicating width of line for cumulative z-score.

szLnASB

NUMERIC value for indicating width of line for alpha-spending boundaries.

szLnOIS

NUMERIC value for indicating width of line for optimal information size.

typPntStdy

NUMERIC value(s) between 1 to 5 for indicating type(s) of observed point(s). Symbols in the current version includes circle, square, diamond, triangle point-up, and triangle point down.

typPntASB

NUMERIC value between 1 to 5 for indicating type of point(s) on alpha-spending boundaries. Symbols in the current version includes circle, square, diamond, triangle point-up, and triangle point down.

typLn0

NUMERIC value for indicating type of null line.

typLnSig

NUMERIC value for indicating type of line for statistical significance.

typLnZCum

NUMERIC value for indicating type of line for cumulative z-score.

typLnASB

NUMERIC value for indicating type of line for alpha-spending boundaries.

typLnOIS

NUMERIC value for indicating type of line for optimal information size.

clrTtl

CHARACTER of a color name for main title.

clrTtlX

CHARACTER of a color name for title on axis X.

clrTtlY

CHARACTER of a color name for title on axis Y.

clrAxsX

CHARACTER of a color name for scale on axis X.

clrAxsY

CHARACTER of a color name for scale on axis Y.

clrLgnd

CHARACTER of a color name for legend.

clrLblY

CHARACTER of a color name for the label "Cumulative z-score" on axis Y.

clrLblStdy

CHARACTER of color name(s) for the label(s) of each data source.

clrLblOIS

CHARACTER of a color name for the label of optimal information size.

clrLblAIS

CHARACTER of a color name for the label of acquired information size.

clrPntStdy

CHARACTER of color name(s) for observed point(s) of data source.

clrPntASB

CHARACTER of a color name for point(s) on the alpha-spending boundaries.

clrLn0

CHARACTER of a color name for null line.

clrLnSig

CHARACTER of a color name for line of statistical significance.

clrLnZCum

CHARACTER of a color name for line of cumulative z-score.

clrLnASB

CHARACTER of a color name for line of alpha-spending boundaries.

clrLnOIS

CHARACTER of a color name for line of optimal information size.

anglStdy

NUMERIC value between 0 and 360 for indicating angle of data source.

BSB

LOGIC value for indicating whether to illustrate beta-spending boundaries.

Value

PlotOSA() returns a plot of observed sequential analysis.

Author(s)

Enoch Kang

References

Jennison, C., & Turnbull, B. W. (2005). Meta-analyses and adaptive group sequential designs in the clinical development process. Journal of biopharmaceutical statistics, 15(4), 537–558. https://doi.org/10.1081/BIP-200062273.

Wetterslev, J., Jakobsen, J. C., & Gluud, C. (2017). Trial sequential analysis in systematic reviews with meta-analysis. BMC medical research methodology, 17(1), 1-18.

NCSS Statistical Software (2023). Group-sequential analysis for two proportions. In PASS Documentation. Available online: https://www.ncss.com/wp-content/themes/ncss/pdf/Procedures/NCSS/Group-Sequential_Analysis_for_Two_Proportions.pdf

See Also

DoSA, DoOSA, PlotPower

Examples

## Not run:
# 1. Import a dataset of study by Fleiss (1993)
library(meta)
data("Fleiss1993bin")

# 2. Perform observed sequential analysis
 output <- DoOSA(Fleiss1993bin, study, year,
                 r1 = d.asp, n1 = n.asp,
                 r2 = d.plac, n2 = n.plac,
                 measure = "RR",
                 group = c("Aspirin", "Control"),
                 plot = TRUE)

# 3. Illustrate plot of observed sequential analysis
 PlotOSA(output)

## End(Not run)