add_description {radiant.data} | R Documentation |
Convenience function to add a markdown description to a data.frame
add_description(df, md = "", path = "")
df |
A data.frame or tibble |
md |
Data description in markdown format |
path |
Path to a text file with the data description in markdown format |
See also register
if (interactive()) {
mt <- mtcars |> add_description(md = "# MTCARS\n\nThis data.frame contains information on ...")
describe(mt)
}