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_number(x, caption_number, ...)# S3 method for default
sprinkle_caption_number(x,
caption_number = getOption("pixie_caption_number", TRUE), ...)
# S3 method for dust_list
sprinkle_caption_number(x,
caption_number = getOption("pixie_caption_number", TRUE), ...)
An object of class dust
logical(1) When TRUE, the table caption
is prefixed with "Table #". Table numbering is suppressed when
FALSE. When numbering is suppressed, the table number counter
will not increment.
Additional arguments to pass to other methods. Currently ignored.
Change the caption_number attribute of the dust object.
Cast an error if x is not a dust object.
Cast an error if caption_number is not a logical object.
Cast an error if caption_number has length greater than 1.
Table numbering makes it possible to reference tables within a document. In some cases, the numbering is not desired. Suppressing numbering may restrict the ability to make reference to the table.