Skip to contents

Read and check a YAML form model

Usage

read_form_model(path, package = NULL)

Arguments

path

File path, or package-relative path when package is supplied.

package

Optional installed package name.

Value

A checked form_model list. Invalid YAML or definitions raise model_form_error with source context and available diagnostics.

Details

Uses YAML 1.1 types: quote versions and codes; use true/false for booleans. Tags, anchors, aliases, merges, directives and document markers are unsupported. The source path is not stored in the model.

Examples

model <- read_form_model("examples/survey-form.yaml", "form.model")
form_metadata(model)
#> $form
#> $form$id
#> [1] "survey"
#> 
#> $form$version
#> [1] "2026.2"
#> 
#> 
#> $schema_version
#> [1] "1.0.0"
#>