metadata_create: Create a metadata table

Description

Create a metadata table from the survey data files.

Usage

metadata_create(survey)
metadata_waves_create(survey_list)

Arguments

survey

A survey data frame.

survey_list

A list containing surveys of class survey.

Value

A nested data frame with metadata and the range of labels, na_values and the na_range itself.

Details

A data frame like tibble ojbect is returned. In case you are working with a list of surveys (waves), call metadata_waves_create, which is a wrapper around a list of metadata_create calls.

The structure of the returned tibble:

filename: The original file name; if present; missing, if a non-survey data frame is used as input survey.
id: The ID of the survey, if present; missing, if a non-survey data frame is used as input survey.
var_name_orig: The original variable name in SPSS.
class_orig: The original variable class after importing withread_spss.
label_orig: The original variable label in SPSS.
labels: A list of the value labels.
valid_labels: A list of the value labels that are not marked as missing values.
na_labels: A list of the value labels that refer to user-defined missing values.
na_range: An optional range of a continuous missing range, if present in the vector.
n_labels: Number of categories or unique levels, which may be different from the sum of missing and category labels.
n_valid_labels: Number of categories in the non-missing range.
n_na_labels: Number of categories of the variable, should be the sum of the former two.
na_levels: A list of the user-defined missing values.

Examples

Run this code

# NOT RUN {
metadata_create (
 survey = read_rds (
          system.file("examples", "ZA7576.rds",
                      package = "retroharmonize")
          )
)
examples_dir <- system.file( "examples", package = "retroharmonize")

my_rds_files <- dir( examples_dir)[grepl(".rds", 
                                        dir(examples_dir))]

example_surveys <- read_surveys(file.path(examples_dir, my_rds_files))
metadata_waves_create (example_surveys)
# }