Group: R6 Class representing a LimeSurvey group

In limonaid: Working with 'LimeSurvey' Surveys and Responses

R6 Class representing a LimeSurvey group

Description

R6 Class representing a LimeSurvey group

R6 Class representing a LimeSurvey group

Details

A group is mostly just a container for questions.

Public fields

group_name

The group name / title / label

description

The group description

grelevance

The relevance equation for the group

group_order

The group order (in the survey)

randomization_group

The randomization group (that the group is a part of)

language

The language of the group; or primary language, if there are multiple languages.

additional_languages

Any additional languages for the title and description elements.

id

The identifier of the group (a unique number in a survey)

sid

The identifier of the survey that this group belongs to

otherOptions

Any additional options, stored as a named list by assigning as.list(...).

questions

The questions in this group

Methods

Public methods

• Group$new()

• Group$add_question()

• Group$export_to_lsg()

• Group$clone()

---

Method new()

Create a new group object. Most of this text comes directly from the TSV manual page at https://www.limesurvey.org/manual/Tab_Separated_Value_survey_structure, so please see that page for more details.

Usage

Group$new(
  group_name = "",
  description = "",
  grelevance = 1,
  group_order = 1,
  randomization_group = NULL,
  language = "en",
  additional_languages = "",
  id = NULL,
  sid = NULL,
  new_id_fun = NULL,
  uqid = NULL,
  repo_url = "https://operationalizations.com/questionnaires/json",
  ...
)

Arguments

group_name

The title of the group (if there are multiple languages, a named vector where every element is the title in another language and every element's name is the language code).

description

The description of the group (if there are multiple languages, a named vector where every element is the title in another language and every element's name is the language code).

grelevance

The group's relevance equation

group_order

The group order (if the group is part of a survey)

randomization_group

The group's randomization group

language

The group's only or primary language

additional_languages

Any additional languages

id

Optionally, the id of the group.

sid

Optionally, the identifier of the survey that this group belongs to.

new_id_fun

A function to set identifiers (for XML exports, which mirrors MySQL tables and so needs identifiers). By default, new question objects receive this function from the group containing them; and groups receive it from the survey containing them. This ensures that identifiers are always unique in a survey (despite question objects not being able to 'see' anything in the group containing them, and group objects not being able to 'see' anything in the survey containing them; because they 'received' this function from the parent object, and it 'bubbles down' through groups to the questions, those functions still get and set a private identifier property in the 'top-most' object).

uqid

A Unique Questionnaire Identifier (UQID) to import a questionnaire and populate the group with it.

repo_url

The URL to a repo serving the questionnaire with the UQID in JSON.

...

Any additional options, stored as a named list in the otherOptions property by assigning as.list(...).

Returns

A new Group object.

---

Method add_question()

Add a question to a group object.

Usage

Group$add_question(
  code,
  type = NULL,
  lsType = NULL,
  question_order = NULL,
  ...
)

Arguments

code

The question code.

type

The question type.

lsType

The question type, as LimeSurvey question type.

question_order

The question order; automatically filled if left empty; starts counting at 0.

...

Additional arguments are used to create the Question using Question$new.

Returns

Invisibly, the thisQuestion object that was just added. Note that you can further modify this, which will modify the question object "in" the survey group as well. This allows you to pipe the question creation on to, for example, add answer options.

---

Method export_to_lsg()

Export the group as an LSG (xml) file.

Usage

Group$export_to_lsg(
  file = NULL,
  preventOverwriting = limonaid::opts$get("preventOverwriting"),
  encoding = limonaid::opts$get("encoding"),
  silent = limonaid::opts$get("silent"),
  backupLanguage = self$language
)

Arguments

file

The filename to which to save the file.

preventOverwriting

Whether to prevent overwriting.

encoding

The encoding to use

silent

Whether to be silent or chatty.

backupLanguage

The language to get content from if not from the primary langage.

parallel

Whether to work serially or in parallel.

Returns

Invisibly, the Survey object.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Group$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

myGroup <- limonaid::Group$new(
  group_name = "My Group"
);
myGroup$add_question(
  "testQuestion1",
  questionTexts = "First question",
  type="free text (short)"
);
myGroup$add_question(
  "testQuestion2",
  questionTexts = "Second question",
  type="radio"
);
myGroup$questions$testQuestion2$add_answer_option(
  "option1",
  "First option"
);
myGroup$questions$testQuestion2$add_answer_option(
  "option2",
  "Second option"
);

cat(as.character(myGroup$export_to_lsg()));

limonaid documentation built on June 10, 2025, 9:10 a.m.