render_codebook: Render codebooks for datasets

In nyuglobalties/blueprintr: Automagically Document and Test Datasets Using Targets Or Drake

Render codebooks for datasets

Description

Render codebooks for datasets

Usage

render_codebook(
  blueprint,
  meta,
  file,
  title = glue::glue("{ui_value(blueprint$name)} Codebook"),
  dataset = NULL,
  template = bp_path("codebook_templates/default_codebook.Rmd"),
  ...
)

Arguments

blueprint	A dataset blueprint
meta	A blueprint_metadata object related to the blueprint
file	Path to where the codebook should be saved
title	Title of the codebook
dataset	If included, a data.frame to be used as a source for summaries
template	Path to the knitr template
...	Extra parameters passed to rmarkdown::render()

nyuglobalties/blueprintr documentation built on July 16, 2024, 10:27 a.m.