write_sframe: Write an instrument to a .sframe file

In surveyframe: Survey Instrument Workflows

Write an instrument to a .sframe file

Description

Serialises an sframe instrument object to a UTF-8 JSON file with a SHA-256 integrity hash. The instrument is validated before writing unless the object already carries a valid status. The hash is computed over the full serialised content with the hash.value field set to an empty string.

Usage

write_sframe(instrument, path, pretty = TRUE, overwrite = FALSE)

Arguments

instrument	An sframe object created by sf_instrument().
path	Character. The file path to write to. The .sframe extension is appended automatically if not already present.
pretty	Logical. Whether to write formatted JSON with indentation. Defaults to TRUE. Set to FALSE for compact files.
overwrite	Logical. Whether to overwrite an existing file. Defaults to FALSE.

Value

The file path, invisibly.

See Also

read_sframe(), validate_sframe()

Examples

instr <- read_sframe(
  system.file("extdata", "tourism_services_demo.sframe",
              package = "surveyframe")
)
out <- write_sframe(instr, tempfile(fileext = ".sframe"))
file.exists(out)

surveyframe documentation built on July 25, 2026, 1:07 a.m.