render_define | R Documentation |
define.pdf
documentrender_spec
is an alias to render_define
. See details.
render_define(x, ...)
## S3 method for class 'yproj'
render_define(
x,
stem = "define_working",
format = "x_table_2",
output_format = "pdf_document",
output_dir = getwd(),
build_dir = definetemplate(),
title = "Data Specification",
author = "",
toc = "yes",
number_sections = "yes",
rmd_template = NULL,
date = as.character(Sys.Date()),
sponsor = NULL,
projectnumber = NULL,
...
)
## S3 method for class 'character'
render_define(x, ..., dots = list())
## S3 method for class 'yspec'
render_define(...)
render_spec(x, ...)
## S3 method for class 'character'
render_spec(x, stem = basename(x), ..., dots = list())
## S3 method for class 'yspec'
render_spec(x, stem = get_meta(x)[["name"]], ..., dots = list())
x |
a |
... |
passed to |
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 |
output_dir |
passed to |
build_dir |
directory where |
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 |
rmd_template |
full path to rmarkdown file to be used to template the data specification document |
date |
used in yaml front matter |
sponsor |
optional project sponsor |
projectnumber |
optional project number in |
dots |
passed to object converter |
stem
should not include a file extension, just
the file stem.
For all document types, the following latex
packages are required:
array
longtable
booktabs
fontenc
Make sure these packages are installed and available when trying to render a document.
file <- ys_help$file()
file
## Not run:
render_define(file)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.