Skip to contents

Convert a codebook specification to PDF

Source: R/template_codebook_to_pdf.R
template_codebook_to_pdf.Rd

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

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

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.

Value

x, invisibly

Examples

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

### Load an example codebook
data("exampleCodebook_1", package = "rock");

rock::template_codebook_to_pdf(
  exampleCodebook_1,
  file = tmpFile
);
#> A new version of TeX Live has been released. If you need to install or update any LaTeX packages, you have to upgrade TinyTeX with tinytex::reinstall_tinytex(repository = "illinois").
#> Warning: running command ''tlmgr' search --file --global '/grffile.sty'' had status 1
#> ! LaTeX Error: File `grffile.sty' not found.
#> 
#> ! Emergency stop.
#> <read *> 
#> Error: LaTeX failed to compile /tmp/RtmpDUyFAE/file4b9ad6d1b3d7d.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See file4b9ad6d1b3d7d.log for more info.
# }