Instruct blueprint to export codebooks — bp_export_codebook • blueprintr

Instruct blueprint to export codebooks

bp_export_codebook(
  blueprint,
  summaries = FALSE,
  file = NULL,
  template = NULL,
  title = NULL
)

Arguments

blueprint: A blueprint
summaries: Whether or not variable summaries should be included in codebook
file: Path to where the codebook should be saved
template: A path to an RMarkdown template
title: Optional title of codebook

Value

An amended blueprint with the codebook export instructions

Examples

if (FALSE) { # \dontrun{
test_bp <- blueprint(
  "mtcars_dat",
  description = "The mtcars dataset",
  command = mtcars
)

new_bp <- test_bp %>% bp_export_codebook()
} # }