xset_waterfall {xpose.xtras} | R Documentation |
Waterfall plot
Description
Generic function primarily used with wrappers targeting types of values changed between two models.
Usage
xset_waterfall(
xpdb_s,
...,
.inorder = FALSE,
type = "bh",
.cols = NULL,
max_nind = 0.7,
scale_diff = TRUE,
show_n = TRUE,
title = NULL,
subtitle = NULL,
caption = NULL,
tag = NULL,
plot_name = "waterfall",
opt,
facets = NULL,
facet_scales = "free_x",
.problem,
.subprob,
.method,
quiet
)
Arguments
xpdb_s |
< |
... |
See < |
.inorder |
See < |
type |
See Details. |
.cols |
< |
max_nind |
If less than 1, the percentile of absolute change values above which to plot. If above 1, the absolute number of subjects is included. To show all, use an extreme positive number like 9999. |
scale_diff |
< |
show_n |
< |
title |
Plot title |
subtitle |
Plot subtitle |
caption |
Plot caption |
tag |
Plot tag |
plot_name |
Metadata name of plot |
opt |
User-specified data options. Only some of these will be used. |
facets |
< |
facet_scales |
< |
.problem |
The problem to be used, by default returns the last one. |
.subprob |
The subproblem to be used, by default returns the last one. |
.method |
The estimation method to be used, by default returns the last one. |
quiet |
Silence extra debugging output |
Details
For type-based customization of plots:
-
b
bar plot (fromgeom_bar
) -
h
hline at 0 (fromgeom_hline
) -
t
text of change value (fromgeom_text
)
Value
The desired plot