Skip to contents

Write a blank Word template for authoring a questionnaire

Source: R/write_form_docx.R
lss_template_docx.Rd

[Experimental]

Usage

lss_template_docx(path, lang = "fr", kinds = lss_kinds$kind, languages = lang)

Arguments

path

Character. Path of the .docx file to write.

lang

Language of the template's labels and example wording, one of "en", "fr" (default), "de", "es", "it".

kinds

Character vector of kinds to illustrate, lss_kinds$kind (all 21) by default; the order of the kind table is kept.

languages

Content languages of the questionnaire to be written, the first one being the primary language. Defaults to lang, giving a single-language form. With several, every text row is repeated once per language, keyed Wording [fr], Wording [en] and so on, and the reader then requires each of them: a questionnaire with a missing translation is what audit_lss() exists to catch. Independent of lang, which only sets the language of the form's own labels.

Value

Invisibly, the path to the written file.

Details

Experimental. Generate the blank authoring form: one example question per requested kind, every default pre-filled, and a muted hint under each key telling the author the syntax the field expects. The template is always generated from the kind table – the package ships no static .docx – so it cannot describe a field lss_spec() would refuse.

Delete the example questions you do not need, edit the others, then hand the file to the reader (0.3.0) to obtain an lss_spec() and, through write_lss(), a .lss file LimeSurvey imports.

The template is the render of a generated example specification, so the same object feeds the template, the tests and the vignette. The value of a Type row is always the spec kind (single, array5, ...); the localized type label is shown as the hint under the key, because it is many-to-one and could not be read back. Reserved words are localized: an option line reading Autre in a French template creates the native other option, and an ordinary option that happens to read "Autre" is written with an explicit code (9 = Autre) – which the hint under the Options key spells out.

Requires the suggested packages officer and flextable.

See also

write_form_docx() to render an existing specification, lss_spec(), write_lss().

Examples

if (requireNamespace("officer", quietly = TRUE) &&
    requireNamespace("flextable", quietly = TRUE)) {
  out <- tempfile(fileext = ".docx")
  lss_template_docx(out, lang = "fr", kinds = c("single", "multiple"))
  file.exists(out)

  # A bilingual questionnaire, with French labels on the form itself.
  both <- tempfile(fileext = ".docx")
  lss_template_docx(both, lang = "fr", languages = c("fr", "en"),
                    kinds = "single")
  file.exists(both)
}
#> ✔ Wrote /tmp/RtmpBU47mp/file1b1910f605ff.docx (2 questions, 1 group, 1 quota).
#> ✔ Wrote /tmp/RtmpBU47mp/file1b194bc67e7a.docx (1 question, 1 group, 1 quota).
#> [1] TRUE