Create a templated report for cognitive interviews — template_ci_heatmap_1_to

Use this function to export a templated report for cognitive interviews. To embed it in an R Markdown file, use !!! CREATE rock::knit_codebook() !!!

Usage

template_ci_heatmap_1_to_pdf(
  x,
  file,
  title = "Cognitive Interview: Heatmap and Coded Fragments",
  author = NULL,
  caption = "Heatmap",
  headingLevel = 1,
  silent = rock::opts$get("silent")
)

Arguments

x: The codebook object (as produced by a call to parse_sources()).
file: The filename to save the codebook to.
title: The title to use.
author: The author to specify in the PDF.
caption: The caption for the heatmap.
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 CI
examplePath <- file.path(system.file(package="rock"), 'extdata');
parsedCI <- parse_source(file.path(examplePath,
                                   "ci_example_1.rock"));

rock::template_ci_heatmap_1_to_pdf(
  parsedCI,
  file = tmpFile
);
#> Warning: LaTeX Warning: Float too large for page by 18.27548pt on input line 87.
# }