exReport {greport} | R Documentation |
Exclusion Report
Description
Generates graphics for sequential exclusion criteria
Usage
exReport(
formula,
data = NULL,
subset = NULL,
na.action = na.retain,
ignoreExcl = NULL,
ignoreRand = NULL,
plotExRemain = TRUE,
autoother = FALSE,
sort = TRUE,
whenapp = NULL,
erdata = NULL,
panel = "excl",
subpanel = NULL,
head = NULL,
tail = NULL,
apptail = NULL,
h = 5.5,
w = 6.5,
hc = 4.5,
wc = 5,
adjustwidth = "-0.75in",
append = FALSE,
popts = NULL,
app = TRUE
)
Arguments
formula |
a formula with only a right-hand side, possibly containing a term of the form |
data |
input data frame |
subset |
subsetting criteria |
na.action |
function for handling |
ignoreExcl |
a formula with only a right-hand side, specifying the names of exclusion variable names that are to be ignored when counting exclusions (screen failures) |
ignoreRand |
a formula with only a right-hand side, specifying the names of exclusion variable names that are to be ignored when counting randomized subjects marked as exclusions |
plotExRemain |
set to |
autoother |
set to |
sort |
set to |
whenapp |
a named character vector (with names equal to names of variables in formula). For each variable that is only assessed (i.e., is not |
erdata |
a data frame that is subsetted on the combination of |
panel |
panel string |
subpanel |
If calling |
head |
character string. Specifies initial text in the figure caption, otherwise a default is used. |
tail |
a character string to add to end of automatic caption |
apptail |
a character string to add to end of automatic caption for appendix table with listing of subject IDs |
h |
height of 2-panel graph |
w |
width of 2-panel graph |
hc |
height of cumulative exclusion 1-panel graph |
wc |
width of this 1-panel graph |
adjustwidth |
used to allow wide detailed exclusion table to go into left margin in order to be centered on the physical page. The default is |
append |
set to |
popts |
a list of options to pass to graphing functions |
app |
set to |
Details
With input being a series of essentially binary variables with positive indicating that a subject is excluded for a specific reason, orders the reasons so that the first excludes the highest number of subjects, the second excludes the highest number of remaining subjects, and so on. If a randomization status variable is present, actually randomized (properly or not) subjects are excluded from counts of exclusions. First draws a single vertical axis graph showing cumulative exclusions, then creates a 2-panel dot chart with the first panel showing that information, along with the marginal frequencies of exclusions and the second showing the number of subjects remaining in the study after the sequential exclusions. A pop-up table is created showing those quantities plus fractions. There is an option to not sort by descending exclusion frequencies but instead to use the original variable order. Assumes that any factor variable exclusions that have only one level and that level indicates a positive finding, that variable has a denominator equal to the overall number of subjects.
Author(s)
Frank Harrell
Examples
# See test.Rnw in tests directory