rock (version 0.8.1)

codebook_to_pdf: Convert a codebook specification to PDF

Description

Use this function to export your codebook specification to a PDF file. To embed it in an R Markdown file, use !!! CREATE rock::knit_codebook() !!!

Usage

codebook_to_pdf(
  x,
  file,
  author = NULL,
  headingLevel = 1,
  silent = rock::opts$get("silent")
)

Value

x, invisibly

Arguments

x

The codebook object (as produced by a call to codebook_fromSpreadsheet()).

file

The filename to save the codebook to.

author

The author to specify in the PDF.

headingLevel

The level of the top-most headings.

silent

Whether to be silent or chatty.

Examples

# \donttest{
### Use a temporary file to write to
tmpFile <- tempfile(fileext = ".pdf");

### Load an example (pre)registration specification
data("exampleCodebook_1", package = "rock");

rock::codebook_to_pdf(
  exampleCodebook_1,
  file = tmpFile
);
# }