sprinkle_label: Change the Border Collapse Property in a Dust Table

Description Usage Arguments Details Functional Requirements Author(s) Source See Also

View source: R/sprinkle_label.R

Description

The label property is used to make references to a table. Labels may be used in LaTeX documents, or in both LaTeX and HTML documents when using bookdown.

Usage

1
2
3
4
5
6
7
sprinkle_label(x, label = NULL, ...)

## Default S3 method:
sprinkle_label(x, label = NULL, ...)

## S3 method for class 'dust_list'
sprinkle_label(x, label = NULL, ...)

Arguments

x

An object of class dust

label

character(1) or NULL for no label.

...

Additional arguments to pass to other methods. Currently ignored.

Details

For details about using labels in LaTeX documents, see https://en.wikibooks.org/wiki/LaTeX/Labels_and_Cross-referencing.

For details about using labels in bookdown documents, see https://bookdown.org/yihui/bookdown/tables.html

Functional Requirements

  1. Change the label attribute of the dust object.

  2. Cast an error if x is not a dust object.

  3. Cast an error if label is not a character(1).

Author(s)

Benjamin Nutter

Source

https://en.wikibooks.org/wiki/LaTeX/Labels_and_Cross-referencing

https://bookdown.org/yihui/bookdown/tables.html

See Also

dust, sprinkle


pixiedust documentation built on Jan. 16, 2021, 5:25 p.m.