Add a data frame to the project data dictionary

Place at the end of a read/clean pipeline to capture column names and optionally sample values. Returns the data frame unchanged.

Usage

tinytrail_dict(
  df,
  df_name = NULL,
  sample_values = TRUE,
  sample_string_length = 18L
)

Arguments

df

A data frame.

df_name

Character. Label for this entry in the data dictionary. Defaults to the variable name of df as written in the calling code (e.g. mtcars |> tinytrail_dict() records as "mtcars"). Override when the expression is not a simple name or when you need a custom label.

sample_values

Logical. Record 5 sample values per column. Default TRUE.

sample_string_length

Integer or Inf. Maximum characters per sample value before truncating with "...". Default 18L.

Value

df, invisibly.

Details

Requires tinytrail() to have been called first in the same session.

See also

tinytrail() to initialise the trail, tinytrail_write() to record output paths explicitly.

Examples

# \donttest{
withr::with_tempdir({
  writeLines("Package: testproject\nVersion: 0.1.0", "DESCRIPTION")

  tinytrail("Analyse data", name = "analysis.R", record_runtime = FALSE)
  dat <- mtcars |> tinytrail_dict(df_name = "cars")
})
# }