ces (version 1.0.2)

download_pdf_codebook: Download Canadian Election Study PDF Codebook

Description

This function downloads the official PDF codebook for a specified year of the Canadian Election Study. The codebook contains detailed information about all variables, question wording, response codes, and methodological details.

Usage

download_pdf_codebook(
  year,
  variant = NULL,
  path = NULL,
  overwrite = FALSE,
  verbose = TRUE
)

Value

Invisibly returns the file path of the downloaded codebook.

Arguments

year

A character string indicating the year of the CES data. Available years include "1965", "1968", "1972", "1974", "1984", "1988", "1993", "1997", "2000", "2004", "2006", "2008", "2011", "2015", "2019", "2021".

variant

A character string indicating the survey variant to download. For years with multiple variants (1972, 2015, 2019), this specifies which one to use. If NULL (default), uses the first available variant for the year.

path

A character string indicating the directory where the codebook should be saved. If NULL (default), the codebook will be saved to the Downloads directory if available, otherwise to a temporary directory.

overwrite

Logical indicating whether to overwrite existing files. Default is FALSE.

verbose

Logical indicating whether to display detailed progress messages during download. Default is TRUE.

Examples

# \donttest{
# Download the 2019 CES codebook to a temporary directory (defaults to web variant)
download_pdf_codebook("2019", path = tempdir(), overwrite = TRUE)

# Download the 2019 phone survey codebook
download_pdf_codebook("2019", variant = "phone", path = tempdir(), overwrite = TRUE)

# Download the 1972 September survey codebook
download_pdf_codebook("1972", variant = "sep", path = tempdir(), overwrite = TRUE)

# Overwrite existing file
download_pdf_codebook("2021", path = tempdir(), overwrite = TRUE)
# }