Skip to contents

Export Responses with Participants Attached

Source: R/limesurvey.R
ls_export.Rd

Export Responses with Participants Attached

Usage

ls_export(
  survey_id,
  attributes = TRUE,
  clean_labels = TRUE,
  n_participants = 999,
  lang = "cs",
  part = "all",
  only_unused_tokens = FALSE,
  join_by = "token",
  ...
)

Arguments

survey_id

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

attributes

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

clean_labels

logical, whether to clean labels of subquestions from repeating parts. Defaults to TRUE.

n_participants

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

lang

character, ISO 639 language code, default to cs.

part

character, completion status, either complete, incomplete or all (the default).

only_unused_tokens

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

join_by

character, the joining variable present in both responses and participants tibbles. Default to token. Pass NULL to join by common variables.

...

Arguments passed on to dplyr::left_join

copy

If x and y are not from the same data source, and copy is TRUE, then y will be copied into the same src as x. This allows you to join tables across srcs, but it is a potentially expensive operation so you must opt into it.

suffix

If there are non-joined duplicate variables in x and y, these suffixes will be added to the output to disambiguate them. Should be a character vector of length 2.

keep

Should the join keys from both x and y be preserved in the output?

  • If NULL, the default, joins on equality retain only the keys from x, while joins on inequality retain the keys from both inputs.

  • If TRUE, all keys from both inputs are retained.

  • If FALSE, only keys from x are retained. For right and full joins, the data in key columns corresponding to rows that only exist in y are merged into the key columns from x. Can't be used when joining on inequality conditions.

Value

A tibble.

See also

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

Examples

if (FALSE) {
ls_export(123456)
}