Output static forest plot
Usage
rtf_static_forestly(
outdata,
plot_calls,
source,
parameter = "any",
n_rows = 25,
orientation = "portrait",
fig_size = c(6, 6),
title = c("analysis", "observation", "population"),
footnotes = NULL,
text_font_size = 9,
path_outdata = tempfile(fileext = ".Rdata"),
path_outtable = tempfile(fileext = ".rtf")
)
Arguments
- outdata
An
outdata
object created byformat_ae_forestly()
.- plot_calls
A list or vector of function calls.
- source
A character value of the data source.
- parameter
A character value of parameter term name.
- n_rows
An integer value of the number of rows per page in a plot.
- orientation
Orientation in 'portrait' or 'landscape'.
- fig_size
A numeric vector of length 2 of figure width and height. The length should be 2 (width, height). The unit is inch.
- title
Term "analysis", "observation" and "population") for collecting title from metadata or a character vector of table titles.
- footnotes
A character vector of table footnotes.
- text_font_size
Text font size. To vary text font size by column, use numeric vector with length of vector equal to number of columns displayed e.g. c(9,20,40).
- path_outdata
A character string of the outdata path.
- path_outtable
A character string of the outtable path.
Examples
forestly_adsl$TRTA <- factor(
forestly_adsl$TRT01A,
levels = c("Xanomeline Low Dose", "Placebo"),
labels = c("Low Dose", "Placebo")
)
forestly_adae$TRTA <- factor(
forestly_adae$TRTA,
levels = c("Xanomeline Low Dose", "Placebo"),
labels = c("Low Dose", "Placebo")
)
outdata <- meta_forestly(
dataset_adsl = forestly_adsl[1:40, ],
dataset_adae = forestly_adae[1:40, ]
) |>
prepare_ae_forestly()|>
format_ae_forestly()
p1 <- substitute(
plot_dot(
tbl,
prop_cols = c("prop_1", "prop_2"),
y_var = "name",
label = c("Treatment", "Placebo")
)
)
p2 <- substitute(
plot_errorbar(
tbl,
ci_cols = c("diff_1", "lower_1", "upper_1"),
y_var = "name",
label = c("Treatment", "Placebo"),
legend_nrow = NULL,
theme = theme_panel(show_ticks = FALSE, show_text = FALSE)
)
)
p3 <- substitute(
table_panel(
tbl,
n_cols = c("n_1", "n_2"),
prop_cols = c("prop_1", "prop_2"),
y_var = "name",
theme = theme_panel(show_ticks = FALSE, show_text = FALSE),
x_label = c("Treatment \n n(%)", "Placebo \n n(%)")
)
)
outdata |> rtf_static_forestly(
plot_calls = c(p1, p2, p3),
source = "Source: [CDISCpilot: adam-adsl; adae]",
path_outdata = tempfile(fileext = ".Rdata"),
path_outtable = tempfile(fileext = ".rtf")
)
#> The outdata is saved in /tmp/RtmpVqTWuu/file1c697a29ad47.Rdata
#> The output is saved in /tmp/RtmpVqTWuu/file1c69304642.rtf