Document survey lists

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" )
#> [1] "example_surveys"
waves_document
#> # A tibble: 3 x 5 #> id filename ncol nrow object_size #> <chr> <chr> <int> <int> <dbl> #> 1 ZA5913 ZA5913.rds 38 35 110192 #> 2 ZA6863 ZA6863.rds 49 50 144848 #> 3 ZA7576 ZA7576.rds 56 45 165824