CIBER
This function generates a highlevel plot consisting of several diamond plots. This function is useful for estimating the relative relevance of a set of determinants of, for example, behavior. The plot in the left hand panel shows each determinant's distribution with a diamond representing the confidence interval. The right hand plot shows the determinants' associations to one or more 'target' variables, such as behavior or determinants of behavior.
 Keywords
 hplot
Usage
CIBER(data, determinants, targets,
conf.level = list(means = 0.9999,
associations = 0.95),
subQuestions = NULL,
leftAnchors = rep("Lo", length(determinants)),
rightAnchors = rep("Hi", length(determinants)),
orderBy = NULL, decreasing = NULL,
generateColors = list(means = c("red", "blue", "green"),
associations = c("red", "grey", "green")),
strokeColors = brewer.pal(9, "Set1"),
titlePrefix = "Means and associations with",
titleVarLabels = NULL, titleSuffix = "",
fullColorRange = NULL, associationsAlpha = 0.5,
returnPlotOnly = TRUE, drawPlot = TRUE,
baseSize = 0.8, dotSize = 2.5 * baseSize,
baseFontSize = 10 * baseSize,
theme = theme_bw(base_size = baseFontSize), ...)detStructCIBER(determinantStructure, dat,
conf.level = list(means = 0.9999,
associations = 0.95),
subQuestions = NULL,
leftAnchors = rep("Lo", length(determinants)),
rightAnchors = rep("Hi", length(determinants)),
orderBy = 1, decreasing = NULL,
generateColors = list(means = c("red", "blue", "green"),
associations = c("red", "grey", "green")),
strokeColors = brewer.pal(9, "Set1"),
titlePrefix = "Means and associations with",
titleVarLabels = NULL, titleSuffix = "",
fullColorRange = NULL, associationsAlpha = 0.5,
baseSize = 0.8, dotSize = 2.5 * baseSize,
baseFontSize = 10 * baseSize,
theme = theme_bw(base_size = baseFontSize), ...)
Arguments
 data, dat
 The dataframe containing the variables.
 determinants
 The 'determinants': the predictors (or 'covariates') of the target variables(s) (or 'criteria').
 targets
 The 'targets' or 'criteria' variables: the variables predicted by the determinants.
 determinantStructure

When using
detStructCIBER
, the determinant structure as generated bydeterminantStructure
is included here.determinants
,targets
,subQuestions
,leftAnchors
, andrightAnchors
are then read from thedeterminantStructure
object. In other words: once adeterminantStructure
has been generated, onlydat
anddeterminantStructure
have to be provided as argument to generate a CIBER diamond plot.  conf.level

The confidence levels for the confidence intervals: has to be a named list with two
elements:
means
andassociations
, specifying the desired confidence levels for the means and associations, respectively. The confidence level for the associations is also used for the intervals for the proportions of explained variance.  subQuestions

The subquestions used to measure each determinants. This can also be
used to provide pretty names for the variables if the determinants
were not measured by one question each. Must have the same length as
determinants
.  leftAnchors

The anchors to display on the left side of the left hand panel. If the
determinants were measured with one variable each, this can be used to
show the anchors that were used for the respective scales. Must have the
same length as
determinants
.  rightAnchors

The anchors to display on the left side of the left hand panel. If the
determinants were measured with one variable each, this can be used to
show the anchors that were used for the respective scales. Must have the
same length as
determinants
.  orderBy

Whether to sort the determinants. Set to
NULL
to not sort at all; specify the name or index of one of thetarget
s to sort by the point estimates of the associations with that target variable. Usedecreasing
to determine whether to sort in ascending or descending order. For convenience, iforderBy
is notNULL
, butdecreasing
is, the determinants are sorted in descending (decreasing) order.  decreasing

Whether to sort the determinants. Specify
NULL
to not sort at all,TRUE
to sort in descending order, andFALSE
to sort in ascending order. Ifdecreasing
is norNULL
, butorderBy
isNULL
, the determinants are sorted by their means. For convenience, iforderBy
is notNULL
, butdecreasing
is, the determinants are sorted in descending (decreasing) order.  generateColors

The colors to use to generate the gradients for coloring the diamonds
representing the confidence intervals. Has to be a named list with two
elements:
means
andassociations
, specifying the desired colors for the means and associations, respectively.  strokeColors
 The palette to use to color the stroke of the confidence intervals for the associations between the determinants and the targets. Successive colors from this palette are used for the targets.
 titlePrefix
 Text to add before the list of target names and the proportions of explained variance for each target. This plot title also serves as legend to indicate which target 'gets' which each color.
 titleVarLabels

Optionally, variable labels to use in the plot title. Has to be the
exact same length as
targets
.  titleSuffix
 Text to add after the list of target names and the proportions of explained variance for each target.
 fullColorRange

If colors are specified, this can be used to specify which values,
for the determinant confidence intervals in the left hand panel,
are the minimum and maximum. This is useful if those scores are not
actually in the data (e.g. for extremely skewed distributions). If
NULL
, the range of all individual scores on the determinants is used. For the associations,c(1, 1)
is always used asfullColorRange
.  associationsAlpha
 The alpha level (transparency) of the confidence interval diamonds in the right hand plot. Value between 0 and 1, where 0 signifies complete transparency (i.e. invisibility) and 1 signifies complete 'opaqueness'.
 returnPlotOnly
 Whether to return the entire object that is generated (including all intermediate objects) or only the plot.
 drawPlot
 Whether the draw the plot, or only return it.
 baseSize
 This can be used to efficiently change the size of most plot elements.
 dotSize
 This is the size of the points used to show the individual data points in the left hand plot.
 baseFontSize

This can be used to set the font size separately from the
baseSize
.  theme
 This is the theme that is used for the plots.
 …

These arguments are passed on to
biAxisDiamondPlot
(for the left panel) anddiamondPlot
(for the right panel). Note that all argument are passed to both those functions.
Details
Details are explained in Crutzen & Peters (2017).
Value
Depending on the value of returnPlotOnly
, either the
plot only (a gtable
object) or an object containing most
objects created along the way (in which case the plot is stored
in $output$bla
).
The plot has width
and height
attributes which can be
used when saving the plot.
References
Crutzen, R., Peters, G.J. Y., & Noijen, J. (2017). How to Select Relevant SocialCognitive Determinants and Use them in the Development of Behaviour Change Interventions? Confidence IntervalBased Estimation of Relevance. http://dx.doi.org/
See Also
biAxisDiamondPlot
, associationsDiamondPlot
, determinantStructure
Examples
CIBER(data=mtcars,
determinants=c('drat', 'wt', 'am',
'gear', 'vs', 'carb'),
targets=c('mpg', 'cyl'));