document_df: Prints framework for documenting a data frame

In jimbrig/jimstools: Tools for R

Prints framework for documenting a data frame

Description

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

Usage

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)

jimbrig/jimstools documentation built on Sept. 12, 2022, 12:08 p.m.