read_voting_register_ids: Read in voting register identifiers

In zdaarau/fokus: Provides an API around the FOKUS Post-voting Surveys

Read in voting register identifiers

Description

Reads in the voting register identifiers of the population that was invited to participate in the FOKUS survey at the specified ballot date in the specified canton.

Usage

read_voting_register_ids(
  ballot_date = pal::pkg_config_val("ballot_date"),
  canton = cantons(ballot_date),
  use_cache = TRUE,
  auth_token = pal::pkg_config_val("token_repo_private")
)

Arguments

ballot_date	FOKUS-covered ballot date. One of "2018-09-23" "2018-11-25" "2019-10-20" "2020-09-27" "2020-10-18" "2021-11-28" "2023-06-18" "2024-10-20"
canton	FOKUS-covered canton name. One of "aargau"
use_cache	Whether or not to return cached results if possible. Caching is done based on file content hashing, so the file is only newly fetched if it actually changed since the last download. If FALSE, the file is always newly fetched.
auth_token	Personal access token of a gitlab.com account with access to the private FOKUS repository.

Details

Note that this data is not available for all FOKUS surveys.

Value

A tibble with the column id_voting_register.

See Also

Other data import functions: read_easyvote_municipalities(), read_online_participation_codes(), read_private_file(), read_survey_data(), read_voting_register_data_extra(), tidy_cols()

Examples

# GitLab PAT with access to the private FOKUS repository is required for this function to work
try(
  fokus::read_voting_register_ids(ballot_date = "2019-10-20",
                                  canton = "aargau") |>
    nrow()
)

zdaarau/fokus documentation built on Dec. 24, 2024, 10:47 p.m.