Render a define.pdf document

render_spec is an alias to render_define. See details.

render_define(x, ...)

# S3 method for yproj
render_define(x, stem = "define_working",
  format = c("x_table", "pander_table", "md_outline"),
  output_format = "pdf_document", output_dir = getwd(),
  build_dir = tempdir(), title = "Data Specification",
  author = "MetrumRG", toc = "yes", number_sections = "yes",
  date = format(Sys.time()), ...)

# S3 method for character
render_define(x, ..., dots = list())

# S3 method for yspec
render_define(...)

render_spec(x, ...)

# S3 method for character
render_spec(x, stem = basename(x), ...,
  dots = list())

# S3 method for yspec
render_spec(x, stem = get_meta(x)[["name"]], ...,
  dots = list())

Arguments

x

a yproj object or project specification file name
...

passed to rmarkdown::render
stem

used to name the output file
format

the name of a function that will generate code formatting the data specification information
output_format

passed to rmarkdown::render
output_dir

passed to rmarkdown::render
build_dir

directory where rmarkdown should build the document
title

used in yaml front matter
author

used in yaml front matter
toc

used in yaml front matter
number_sections

used in yaml front matter
date

used in yaml front matter
dots

passed to object converter

Details

stem should not include a file extension, just the file stem.

Examples


file <- ys_help$file()

file
#> [1] "/data/deployment/2020-03-09/renv/library/R-3.6/x86_64-pc-linux-gnu/yspec/internal/analysis1.yml"

if (FALSE) {
  render_define(file)
}