Prints framework for documenting a data frame

Source: R/document_df.R

Prints the standard fframework for documenting a data frame in an R package.

document_df(df, num_spaces = 4)

Arguments

df

data frame object; can be a data.frame, data.table, or tibble
num_spaces

number of a spaces per tab; default is 4

Value

nothing

Examples

set.seed(0)
dat <- data.frame(x = c(LETTERS[1:5]),
                  y = c(sample(1:100, 5)))
document_df(dat)
#> #' @format a data.frame (5 x 2)
#> #' \describe{
#> #'     \item{x}{}
#> #'     \item{y}{}
#> #' }