ls_participants: List Participants

Description Usage Arguments Value See Also Examples

View source: R/limesurvey.R

Description

Fetches participant list of the solicited survey. The function tries to retrieve as many attributes as possible and translate them to their "semantic" version by default. You can also provide character vector of requested attributes, but not in the "semantic" form (use, e.g., attribute_1 or usesleft).

Usage

1
2
3
4
5
6
7
ls_participants(
  survey_id,
  attributes = TRUE,
  n_participants = 999,
  only_unused_tokens = FALSE,
  translate_attrs = TRUE
)

Arguments

survey_id

integer, ID of the survey (as found, e.g., with ls_surveys()).

attributes

logical try to recover all attributes (default to TRUE), or character vector specifying requested attributes.

n_participants

integer, the number of participants to list, defualt to 999.

only_unused_tokens

logical, should only the unused tokens be listed? Default to FALSE.

translate_attrs

logical, should the custom attributes be "translated" to "semantic" version? Default to TRUE.

Value

A tibble, or raw object if server response cannot be reasonably coerced to a tibble.

See Also

Other LimeSurvey functions: ls_add_participants(), ls_call(), ls_export(), ls_get_attrs(), ls_invite(), ls_login(), ls_responses(), ls_set_participant_properties(), ls_surveys()

Examples

1
2
3
4
## Not run: 
ls_participants(123456, attributes = c("usesleft"))

## End(Not run)

scholaempirica/reschola documentation built on Jan. 22, 2022, 2 p.m.