Skip to contents

Fetches the metadata table from Redivis and returns it as a tibble. Automatically checks for updates and refreshes only when needed.

Usage

irw_metadata(source = "core", sim = FALSE, comp = FALSE, nom = FALSE)

Arguments

source

Character. The data family: "core" (default), "nom", "sim", "comp", "conj" (conjoint experiments; see irw_conj_long), "rank" (rankings; see irw_rank_compress), or "cov" (published correlation and covariance matrices: one row per matrix, that is per table and group, with n_vars, n_obs, stat, has_sd, has_mean, min_eigenvalue, is_pd, n_missing_cells and the matrix's record: matrix_type, missing, population, source_citation, source_location, via, capture, verified, licence, licence_source, notes).

sim

Deprecated. Use source = "sim" instead.

comp

Deprecated. Use source = "comp" instead.

nom

Deprecated. Use source = "nom" instead.

Value

A tibble containing metadata information.

Details

Each source has its own columns. For source = "conj" a row is one conjoint experiment: n_respondents, n_rows, n_tasks, n_profiles, n_attributes, outcomes, n_optout_tasks, and the design facts country, display_language, label_language, restrictions (none, yes, observed or unknown), restrictions_note, task_source and profile_source (recorded or inferred from row order), and the topic tags domain (what the study is about; one or more values joined with ";", primary first) and choice_object (what one profile represents). Both are filters in irw_filter, which documents their vocabularies. levels_labelled is full when every attribute holds the level text respondents saw, partial or none when some or all hold only the deposit's codes (columns named attr_<name>_code); it is a filter too.

For source = "rank" a row is one rankings table: the counts n_respondents, n_rows, n_tasks, n_items, max_resp (highest position marked), n_duplicate_marks and n_tied_ballots (rankings with two items at one position; see irw_rank_compress), and the design record (method, seats, n_positions, n_candidates, n_ballots_cast, n_ballots_with_marks, jurisdiction, date, office, ...), whose codes are documented in the irw repo's data/rankings/README.md.