Create a codebook

writeCodeBookLatex(
  ds,
  url = NULL,
  pdf = TRUE,
  title = NULL,
  subtitle = NULL,
  table_of_contents = FALSE,
  sample_desc = NULL,
  field_period = NULL,
  preamble = NULL,
  suppress_zero_counts = FALSE,
  appendix = TRUE,
  logo = NULL,
  position = NULL,
  path = NULL,
  logging = FALSE,
  open = FALSE,
  filename = NULL,
  ...
)

Arguments

ds

A crunch dataset

url

A crunch dataset url

pdf

Should we write directly to pdf? Defaults to TRUE. title = getName(data_summary),

title

An optional title. Defaults to the data summary title.

subtitle

An optional character subtitle. Defaults to an empty string.

table_of_contents

logical. Should a list of tables be included at the start of the report Defaults to FALSE.

sample_desc

A character string describing the sample.

field_period

A character string describing the field period.

preamble

A latex string, usually a methodological statement. LaTeX should be escaped.

suppress_zero_counts

Should zero count categories be supressed? Defaults to FALSE.

appendix

Should categorical questions with greater than 20 categories be put in an apppendix? Defaults to TRUE.

logo

Default to NULL. A character string one of: yougov or ygblue. Includes the logo automatically. Also accepts a path to a logo file.

position

Defaults to NULL. Identifies the position of the table on the page. Accepts "c", "l", or "r". Default position is left aligned tables.

path

The path to place .tex and .pdf files.

logging

Leave logs in the working directory, defaults to FALSE

open

Should the resulting PDF be opened? Defaults to FALSE

filename

A string. The desired basename of the resulting file with no extension (i.e, "mycodebook")

...

Additional arguments passed to kable_styling Unused.