survey_strata: Survey the layout and execution order of a strata project

View source: R/survey-core.R

survey_strataR Documentation

Survey the layout and execution order of a strata project

Description

survey_strata() will examine the .tomls in project_path provided and return a dataframe with the following information about the project:

  • stratum_name: the name of the stratum

  • lamina_name: the name of the lamina

  • execution_order: the order in which the stratum-lamina-code combination will be executed

  • script_name: the name of the script to be executed

  • script_path: the path to the script

This is based on the contents of the .toml files, everything else is "invisible" inside the strata project.

Usage

survey_strata(project_path)

Arguments

project_path

A path to strata project folder.

Value

dataframe housing the layout of your project based on the .tomls.

See Also

Other survey: survey_log(), survey_tomls()

Examples

tmp <- fs::dir_create(fs::file_temp())
build_quick_strata_project(tmp, 2, 2)
survey_strata(tmp)
fs::dir_delete(tmp)

strata documentation built on April 12, 2025, 2:20 a.m.