forestPlotGen.manyGroups: Generates individual-level figure for 'Forest Plot' tab

In sanoke/hetviz: Treatment Effect Heterogeneity visualization

Description

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

Usage

forestPlotGen.manyGroups(ds, displayMedian = TRUE, displayError = TRUE,
  displayLine = FALSE, displayMarMean = TRUE)

Arguments

ds	A dataset 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?

Value

If an untenable combination 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.

Details

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

See Also

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

sanoke/hetviz documentation built on March 4, 2020, 7:58 a.m.