microplot (version 1.0-45)

latex.AEdotplot: Display the AE (Adverse Events) dotplot of incidence and relative risk from the HH package in a 'LaTeX' tabular environment or in an 'MS Word' or an 'HTML' table.

Description

The AEdotplot function constructs a display of the most frequently occurring AEs (Adverse Events) in the active arm of a clinical study. The latex method takes the incidence panel and the relative risk panel from the AEdotplot and places them in a 'LaTeX' tabular environment along with the numerical table of counts, percents, and relative risks. The msWord method takes the incidence panel and the relative risk panel from the AEdotplot and places them in an 'MS Word' table along with the numerical table of counts, percents, and relative risks.

Usage

# S3 method for AEdotplot
latex(object, figPrefix = first.word(deparse(substitute(object))),
      rowlabel="Most Frequent On-Therapy Adverse Events",
      device="pdf", ...)
# S3 method for AEdotplot
msWord(object, figPrefix = first.word(deparse(substitute(object))),
       device="png",
       height.panel=.25, height.x.axis=.45,
       width.left=2, width.right=1.5,
       height.key=height.panel,
       width.dataobject=.7,
       rowlabel="Adverse Event", width.rowname=2,
       ...)
# S3 method for AEdotplot
microplot(object, figPrefix, width.left=2, width.right=1.5,
          height.panel=.2, height.x.axis=.45, ...)

Value

For latex.AEdotplot, the "latex" object giving the pathname of the .tex file containing the 'LaTeX' tabular environment constructed by the latex function. For msWord.AEdotplot, the "msWordFilename" object giving the pathname of the .docx file containing the generated table constructed by the msWord.microplotMatrix

function which in turn uses functions in the flextable

package.

The microplot.AEdotplot method returns a list containing the "microplotMatrix" and the data.frame.

Arguments

object

An "AEdotplot" object as constructed by the AEdotplot.

figPrefix

Beginning characters for names of the sequence of generated graphics files. The 'latex' macro \includegraphics requires that there be no "." in the filename basename. We replace all "." in the figPrefix by "-".

device

Forwarded to microplot.

width.left, width.right

width.left is width.panel for the Percent column and width.right is the width.panel for the Relative Risk column of the AEdotplot. See AEdotplot and microplot.

height.panel, height.x.axis, height.key

See microplot.

width.dataobject, width.rowname

See msWord.

rowlabel

See latex.trellis or msWord.

...

Additional arguments to microplot.AEdotplot are forwarded to the microplot.trellis method. Additional arguments to latex.AEdotplot are forwarded to microplot.AEdotplot and to latex. Additional arguments to msWord.AEdotplot are forwarded to microplot.AEdotplot and to msWord.

Author

Richard M. Heiberger <[e-mail]>

Details

The microplot.AEdotplot function does most of the work, taking apart the "AEdotplot" object and constructing from it the set of graphics files identified in a "microplotMatrix" object and collecting the numerical data into a data.frame. The "microplotMatrix" and the data.frame are returned.

The latex and msWord methods call the microplot method and then the latex or msWord generic. The msWord method has more arguments than the latex method because it doesn't pick up the height and width dimensions from the graphics (.png) files.

See Also

See AEdotplot and latex for details on the operation of the latex method.

Examples

## See
## demo("AEdotplot", package="microplot", ask=TRUE)