plot_intervals {confinterpret} | R Documentation |
Plot intervals
Description
Plot intervals on a canvas, typically prepared with
plot_region_canvas()
.
Usage
plot_intervals(intervals, estimates = NULL, interval_value_labels = FALSE,
estimate_value_labels = FALSE, interval_labels_offset,
estimate_labels_offset, interval_type = "norm",
plot_estimate_marks = FALSE, estimate_mark_points = c(1.2 *
graphics::strheight("M"), 0.05, -1.2 * graphics::strheight("M"), -0.05), ...)
Arguments
intervals |
The interval(s) to be plotted. Two column matrix. |
estimates |
Estimates for each of the intervals (optional). |
interval_value_labels |
Logical value specifying whether interval value labels are to be added. |
estimate_value_labels |
Logical value specifying whether estimate value labels are to be added. |
interval_labels_offset |
Amount to offset interval labels by from the centre of the end
of the interval's plot. |
estimate_labels_offset |
Amount to offset estimate labels by. |
interval_type |
Set the way the interval is presented. Current options are
|
plot_estimate_marks |
Whether to plot marks at the x location of the estimates. |
estimate_mark_points |
y positions of the ends of the estimate marks as a numeric vector of length 4. Values are, in order: start (relative to centre), end (relative to box top), start (relative to centre), end (relative to box bottom). |
... |
Further parameters to be passed on. |
Details
The estimate_mark_points
parameter can be used to set the length of
estimate marks, if they are requested using
plot_estimate_marks = TRUE
. The default is extending a little above
and below the interval plot shape and with a gap in the middle big enough
for a line of text (a bit bigger than the height of letter "M"). To leave
no gap, set the first and third elements to zero, e.g.
estimate_mark_points = c(0, 0.05, 0, -0.05)
. To have the marks not
extend outside of the interval shape, set the second and fourth elements to
zero, e.g. estimate_mark_points = c(0, 0, 0, 0)
.