vl_mark_errorband
vl_mark_errorband.Rd
vl_mark_errorband
Usage
vl_mark_errorband(
spec,
band = NULL,
borders = NULL,
clip = NULL,
color = NULL,
extent = NULL,
interpolate = NULL,
opacity = NULL,
orient = NULL,
tension = NULL,
.object = NULL
)
Arguments
- spec
An input vega-lite spec
- band
boolean
Or: MarkConfig
- borders
boolean
Or: MarkConfig
- clip
Whether a composite mark be clipped to the enclosing group’s width and height.
- color
Default color.
Default value: <span style="color: #4682b4;">■</span>
"#4682b4"
Note:
This property cannot be used in a style config.
The
fill
andstroke
properties have higher precedence thancolor
and will overridecolor
.
- extent
The extent of the band. Available options include:
"ci"
: Extend the band to the confidence interval of the mean."stderr"
: The size of band are set to the value of standard error, extending from the mean."stdev"
: The size of band are set to the value of standard deviation, extending from the mean."iqr"
: Extend the band to the q1 and q3.
Default value:
"stderr"
.- interpolate
The line interpolation method for the error band. One of the following:
"linear"
: piecewise linear segments, as in a polyline."linear-closed"
: close the linear segments to form a polygon."step"
: a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes at the midpoint of each pair of adjacent x-values."step-before"
: a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes before the x-value."step-after"
: a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes after the x-value."basis"
: a B-spline, with control point duplication on the ends."basis-open"
: an open B-spline; may not intersect the start or end."basis-closed"
: a closed B-spline, as in a loop."cardinal"
: a Cardinal spline, with control point duplication on the ends."cardinal-open"
: an open Cardinal spline; may not intersect the start or end, but will intersect other control points."cardinal-closed"
: a closed Cardinal spline, as in a loop."bundle"
: equivalent to basis, except the tension parameter is used to straighten the spline."monotone"
: cubic interpolation that preserves monotonicity in y.
- opacity
The opacity (value between [0,1]) of the mark.
- orient
Orientation of the error band. This is normally automatically determined, but can be specified when the orientation is ambiguous and cannot be automatically determined.
- tension
The tension parameter for the interpolation type of the error band.
- .object
Directly input an object, rather than creating one via the other arguments. Should not be used in conjunction with the other arguments other than
spec
. Objects can be of type: ErrorBandDef