plot.frag.ma: Plot Method for "frag.ma" Objects

View source: R/plot.frag.ma.R

plot.frag.maR Documentation

Plot Method for "frag.ma" Objects

Description

Visualizes the iterative process of event status modifications for deriving the fragility index/quotient of a meta-analysis with a binary outcome.

Usage

## S3 method for class 'frag.ma'
plot(x, xlab, ylab, xlim, ylim, ybreaks = NULL,
     study.marker = TRUE, cex.marker, offset.marker, col.line, lwd,
     legend, x.legend, y.legend, cex.legend, ...)

Arguments

x

an object of class "frag.ma" produced by the function frag.ma.

xlab

a label for the x axis.

ylab

a label for the y axis.

xlim

the x limits c(x1, x2) of the plot.

ylim

the y limits c(y1, y2) of the plot.

ybreaks

a vector of the two numeric values for breaking the y axis or NULL (the default, not breaking the y axis). The two values should be between the total event counts in groups 0 and 1, and the first value should be less than the second value. It is useful when the total event counts in the two groups differ a lot, leading to a large distance between the two lines representing the event status modifications in the two groups.

study.marker

a logical value indicating whether study labels involved in event status modifications are presented in the plot (the default is TRUE). When using the default, an asterisk represents that the study with an event status modification remains the same as in the previous iteration.

cex.marker

the size of study labels (when study.marker = TRUE) with the default 0.8.

offset.marker

a numeric value controlling the distance between study labels from the lines (the default is 0.2). It is passed to the function text.

col.line

a vector of the two colors for two lines representing the event status modifications in groups 0 and 1. The default includes "blue" (for group 0) and "red" (for group 1).

lwd

the width of the lines (the default is 1).

legend

the legend of plot. The default gives the two groups.

x.legend

the x co-ordinate or a keyword, such as "right" (the default), to be used to position the legend. It is passed to legend.

y.legend

the y co-ordinate to be used to position the legend (the default is NULL).

cex.legend

the size of legend text (the default is 1).

...

other arguments that can be passed to plot.default.

Details

A plot showing the iterative process of event status modifications is generated. The x axis presents the iterations, and the y axis gives the group-specific total event counts.

Value

None.

References

Lin L, Chu H (2022). "Assessing and visualizing fragility of clinical results with binary outcomes in R using the fragility package." PLOS ONE, 17(6), e0268754. <doi: 10.1371/journal.pone.0268754>

See Also

frag.ma


fragility documentation built on Aug. 30, 2022, 1:10 a.m.