Package index • idem

Read & construct

Create an xlsform object by reading an .xlsx file from disk or by assembling one directly from in-memory data frames.

read_xlsform(): Read an XLSForm file
xlsform(): Construct an xlsform object from data frames

Extract form components

Pull specific pieces of information out of an xlsform object — question names, choice-list names referenced in the survey, list names defined in the choices sheet, and the full set of choice options per list. These accessors are also used internally by the validation functions.

xlsform_questions(): Get question names from an XLSForm
xlsform_referenced_list_names(): Get list names referenced in an XLSForm's survey sheet
xlsform_defined_list_names(): Get list names defined in the choices sheets of an XLSForm
xlsform_choices(): Get choice options from an XLSForm

Validate

Validate a dev XLSForm against an authoritative target reference form. The top-level validate_xlsform() function runs all checks and returns a tidy tibble of issues; the individual validate_*() functions each cover one check and can be run independently when finer control is needed.

validate_xlsform(): Validate an XLSForm against a reference form
validate_question_names(): Validate question names between two XLSForms
validate_list_names(): Validate defined list names between two XLSForms
validate_survey_list_names(): Validate survey-referenced list names between two XLSForms
validate_choices(): Validate choice options between two XLSForms

Datasets

Bundled reference XLSForms included with the package.

msna_template_required: MSNA template XLSForm (required questions)

Miscellaneous

idem_passing_lists: Default list names skipped by validate_choices()