document_waves {retroharmonize}

Document survey lists

Description

Document the key attributes surveys in a survey list.

Usage

document_waves(survey_list)

Arguments

survey_list

A list of survey objects.

Value

Returns a data frame with the key attributes of the surveys in a survey list: the name of the data file, the number of rows and columns, and the size of the object as stored in memory.

See Also

Other documentation functions: document_survey_item()

Examples

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))
 
waves_document <- document_waves(example_surveys)

attr(waves_document, "original_list" )
waves_document