Skip to contents

Render

Render a LimeSurvey survey to a Word or PDF document. The output format is inferred from the extension of output (.docx or .pdf). Each function accepts either a path to a .lss file or a pre-parsed lss object returned by read_lss().

render_questionnaire()
Render a LimeSurvey questionnaire to a Word or PDF document
render_audit()
Render the audit as a focused Word or PDF document

Read and audit

Parse a .lss file into a structured object, and audit a survey for reviewable anomalies (missing translations, dangling references, structural issues). Useful for inspecting a survey before rendering, or for rendering several variants from a single parse.

read_lss()
Read a LimeSurvey .lss file
audit_lss()
Audit a LimeSurvey survey for reviewable anomalies

Author (experimental)

Build a survey specification programmatically and write it as an importable LimeSurvey 6 .lss file. The specification is validated in depth at construction time, because LimeSurvey imports silently and only surfaces mistakes once respondents hit them. The written file round-trips through read_lss() and audit_lss(). The same specification can also be rendered as a Word authoring form – one key/value table per block, meant to be filled in and handed back – either from an existing spec or as a blank template, and read back from the filled-in form into a specification, with a dry-run check that lists every problem of a document at once. An existing survey read by read_lss() can be converted back into a specification, so a questionnaire already in LimeSurvey can be edited through the same form.

lss_spec() experimental
Build and validate a survey specification
write_lss() experimental
Write a survey specification to an importable .lss file
as_lss_spec() experimental
Turn a parsed LimeSurvey survey into an authoring specification
write_form_docx() experimental
Render a survey specification as a Word authoring form
lss_template_docx() experimental
Write a blank Word template for authoring a questionnaire
read_form_docx() experimental
Read a Word authoring form back into a survey specification
check_form_docx() print(<lss_form_check>) experimental
Report every problem of a Word authoring form at once

Package overview

lssdoc lssdoc-package
lssdoc: 'LimeSurvey' '.lss' Questionnaires to and from Word Documents