Structural summary of a survey

Usage

survey_summary(qsf, blocks = NULL)

Arguments

qsf: A qsf_raw object from read_qsf().
blocks: Optional precomputed resolve_live_blocks() result for this qsf (internal reuse; NULL computes it here).

Value

A list: survey_name, n_questions, n_pages, n_blocks, n_branches, n_randomisers, n_loop_blocks, n_end_points. n_pages counts the pages of the live blocks that hold at least one question: each block starts a page and each page break adds one. Like n_questions, it counts a Loop & Merge block once, not once per pass.

Examples

qsf_path <- system.file("extdata", "demo_travel_survey.qsf",
                         package = "surveyBurden")
survey_summary(read_qsf(qsf_path))
#> $survey_name
#> [1] "Neighbourhood Travel Survey (demo)"
#> 
#> $n_questions
#> [1] 26
#> 
#> $n_pages
#> [1] 12
#> 
#> $n_blocks
#> [1] 12
#> 
#> $n_branches
#> [1] 3
#> 
#> $n_randomisers
#> [1] 0
#> 
#> $n_loop_blocks
#> [1] 2
#> 
#> $n_end_points
#> [1] 2
#>