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

Description Usage Arguments Value Details See Also

View source: R/forestPlot-plotFcns.R

Description

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

Usage

1
forestPlotGen.fewGroups(ds, displayBoxplot = TRUE, jitter = TRUE, simData)

Arguments

ds

A dataset of a very specific structure, as defined within dataCompat()

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?)

simData

A logical scalar, indicating whether the data is the simple simulated data

Value

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.

Details

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

See Also

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


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