The table caption is often used as a brief title, but may also be used to provide a longer statement explaining how to interpret the table results.
sprinkle_caption(x, caption, ...)# S3 method for default
sprinkle_caption(x, caption, ...)
# S3 method for dust_list
sprinkle_caption(x, caption, ...)
An object of class dust
character(1)
giving the new caption for the table.
Additional arguments to pass to other methods. Currently ignored.
Change the caption
attribute of the dust
object.
Cast an error if x
is not a dust
object.
Cast an error if caption
is not a character object.
Cast an error if caption
has length greater than 1.
Benjamin Nutter
The caption may be set during the initial dust
call. This
method allows for modification afterward, such as in the case of when a
dust
object is loaded from memory and the initial call cannot be
accessed.
dust
, sprinkle