forestPlot: Generates figure for 'Forest Plot' tab
In sanoke/hetviz: Treatment Effect Heterogeneity visualization

Description Usage Arguments Value Details See Also

forestPlot() is an internal function that takes a dataset and returns a plot.

forestPlot(ds, displayMedian = TRUE, displayError = TRUE,
  displayLine = TRUE, displayMarMean = TRUE, displayBoxplot = TRUE,
  jitter = TRUE, col.outcome, col.trt, col.ITE, col.grp, simData,
  indivPlot = TRUE)

`ds`	Any object that can be coerced into a `data.frame`, that contains data needed for plotting. This dataset is of a very specific structure, as defined within `dataCompat()`.
`displayMedian`	A logical scalar. In the case of subgroup-level plotting (`indivPlot = FALSE`), should the median treatment effect for each subgroup be displayed?
`displayError`	A logical scalar. In the case of subgroup-level plotting (`indivPlot = FALSE`), should the error bars for each subgroup be displayed?
`displayLine`	A logical scalar. In the case of subgroup-level plotting (`indivPlot = FALSE`), should a line connecting the median from each subgroup be displayed?
`displayMarMean`	A logical scalar. In the case of subgroup-level plotting (`indivPlot = FALSE`), should a vertical line denoting the marginal mean be displayed?
`displayBoxplot`	A logical scalar. In the case of individual-level plotting (`indivPlot = TRUE`), should the boxplot for each subgroup be displayed?
`jitter`	A logical scalar. In the case of individual-level plotting (`indivPlot = TRUE`), should the plot contain the jittered individual-level data (typically estimated ITEs?)
`col.outcome`	A scalar integer, indicating the column of the `ds` that contains the outcome.
`col.trt`	A scalar integer, indicating the column of the `ds` that contains the (binary) treatment.
`col.ITE`	A scalar integer, indicating the column of the `ds` that contains the estimated ITEs.
`col.grp`	A scalar integer, indicating the column of the `ds` that contains the grouping indicator.
`simData`	A logical scalar, indicating whether the data is the simple simulated data (`TRUE`) or is more complex (`FALSE`).
`indivPlot`	A logical scalar, indicating whether to generate a plot at the individual level (`TRUE`) or at the subgroup level (`FALSE`).

If both of the logical arguments are false, the output will be a plotly object containing an empty plot. Otherwise, the output will be a ggplot object containing the plot.

This function calls shiny::incProgress(), which is used to increment the progress bar within the UI.

Other plotting functions: covarProfiles, forestPlotGen.fewGroups, forestPlotGen.manyGroups, groupQuantiles, subgroupProfiles, vizByCovar, vizBySubgroup