add_description: Convenience function to add a markdown description to a...

In radiant-rstats/radiant.data: Data Menu for Radiant: Business Analytics using R and Shiny

Convenience function to add a markdown description to a data.frame

Description

Convenience function to add a markdown description to a data.frame

Usage

add_description(df, md = "", path = "")

Arguments

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

See also register

Examples

if (interactive()) {
  mt <- mtcars |> add_description(md = "# MTCARS\n\nThis data.frame contains information on ...")
  describe(mt)
}

radiant-rstats/radiant.data documentation built on Jan. 19, 2024, 12:21 p.m.