ys_col_note | R Documentation |
Produces a string with <col-name>: <col-definition>
format which can be
included in a table note providing a more informative definition with the
column name. The column definition can be generated from the short
name
or the label
(but note that these could frequently be the same).
ys_col_note(
.spec,
...,
.unit = FALSE,
.title_case = FALSE,
.sep = ": ",
.to_string = TRUE,
.collapse = "; ",
.width = NULL,
.type = c("short", "label")
)
.spec |
a yspec object. |
... |
passed to |
.unit |
logical; if |
.title_case |
logical; if |
.sep |
a string to separate column name and column definition; usually a space should be included as the terminal character (see default). |
.to_string |
logical; if |
.collapse |
a string to separate items when |
.width |
if |
.type |
selects if the column definition is generated from calling
|
A string of length one when .to_string
is TRUE
or a character vector
if .to_string
is FALSE
.
spec <- ys_help$spec()
ys_col_note(spec, AST, ALT, SCR, .unit = TRUE)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.