Package 'limonaid'

Description

Working With LimeSurvey Surveys and Responses

Details

LimeSurvey is Free/Libre Open Source Software for the development and administrations of online studies, using sophisticated tailoring capabilities to support multiple study designs. This package supports programmatic creation of surveys that can then be imported into LimeSurvey, as well as userfriendly import of responses from LimeSurvey studies.

Author(s)

Gjalt-Jorn Peters [email protected]

See Also

Useful links:

• https://limonaid.opens.science

• Report bugs at https://codeberg.org/R-packages/limonaid/issues

Description

This is a convenience function that allows you to add an answer option to a question object.

Usage

add_answer_option_to_question(question, ...)

Arguments

Value

The question object.

Examples

myQuestion <-
  limonaid::Question$new(
    code = 'myQuestion',
    type='radio'
  ) |>
  add_answer_option_to_question(
    code = 1,
    optionTexts = "First option"
  ) |>
  add_answer_option_to_question(
    code = 2,
    optionTexts = "Second option"
  );

Description

This is used when creating dataframes for TSV exports.

Usage

append_lsdf_rows(data, row)

Arguments

Value

A merged dataframe.

Examples

limonaid::append_lsdf_rows(mtcars, iris);

Description

The cat0 function is to cat what paste0 is to paste; it simply makes concatenating many strings without a separator easier.

Usage

cat0(..., sep = "")

Arguments

Value

Nothing (invisible NULL, like cat).

Examples

cat0("The first variable is '", names(mtcars)[1], "'.");

Description

This function efficiently checks for the presence of a package without loading it (unlike library() or require(). This is useful to force yourself to use the package::function syntax for addressing functions; you can make sure required packages are installed, but their namespace won't attach to the search path.

Usage

checkPkgs(
  ...,
  install = FALSE,
  load = FALSE,
  repos = "https://cran.rstudio.com"
)

Arguments

Value

Invisibly, a vector of the available packages.

Examples

limonaid::checkPkgs('base');

### Require a version
limonaid::checkPkgs(limonaid = "0.2.0");

### This will show the error message
tryCatch(
  limonaid::checkPkgs(
    base = "99",
    stats = "42.5",
    ufs = 20
  ),
  error = print
);

Description

Tries to 'smartly' convert factor and character vectors to numeric.

Usage

convertToNumeric(vector, byFactorLabel = FALSE)

Arguments

Value

The converted vector.

Examples

convertToNumeric(as.character(1:8));

Description

This function is used by append_lsdf_rows(), and you normally should not use it directly.

Usage

emptyDf(colnames, nrow, fillWith = "")

Arguments

Value

The data.frame.

Examples

limonaid::emptyDf(c("x", "y"), 3);

Description

Sometimes it is useful to export a version of a survey with a different primary language, and/or less additional languages. This function allows that.

Usage

export_with_languages(
  x,
  language,
  path,
  additional_languages = NULL,
  new_sid = x$sid,
  backupLanguage = x$language,
  prefix = "limesurvey--",
  suffix = "",
  parallel = TRUE
)

Arguments

Value

Invisibly, the cloned and altered survey object.

Examples

### Add later

Description

This function logs into the LimeSurvey API and provides an access session key. It was adapted by Gjalt-Jorn Peters from a function originally written by Andrew Heiss.

Usage

get_session_key(
  username = getOption("lime_username"),
  password = getOption("lime_password"),
  hostname = getOption("lime_api")
)

Arguments

Value

API token

Examples

## Not run: 
get_session_key()

## End(Not run)

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

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

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

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

Returns

Invisibly, the Survey object.

Method clone()

The objects of this class are cloneable with this method.

Usage

Group$clone(deep = FALSE)

Arguments

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()));

Description

This function converts raw base64 results into a data frame. It was adapted by Gjalt-Jorn Peters from a function originally written by Andrew Heiss.

Usage

limer_base64_to_df(
  x,
  encoding = NULL,
  iconvArgs = list(from = "UTF-8", to = "UTF-8")
)

Arguments

Examples

## Not run: 
limer_base64_to_df()

## End(Not run)

Description

This function makes a generic call to the LimeSurvey API. See https://www.limesurvey.org/manual/RemoteControl_2_API for API documentation. It was adapted by Gjalt-Jorn Peters from a function originally written by Andrew Heiss.

Usage

limer_call_limer(method, params = list(), ..., encoding = "utf-8")

Arguments

Value

Results from the API (sometimes plain text, sometimes base64-encoded text).

Examples

## Not run: 
limer_call_limer(method = "list_surveys")
limer_call_limer(method = "get_summary",
                 params = list(iSurveyID = 238481,
                               sStatname = "completed_responses"))

## End(Not run)

Description

This function exports and downloads a participant property from a LimeSurvey survey. It was adapted by Gjalt-Jorn Peters from a function originally written by Andrew Heiss.

Usage

limer_get_participant_property(
  iSurveyID,
  aTokenQueryProperties,
  aTokenProperties
)

Arguments

Examples

## Not run: 
limer_get_participant_property(
  iSurveyID = 12345,
  aTokenQueryProperties = 1,
  aTokenProperties = list("attribute_1")
);

## End(Not run)

Description

This function exports and downloads the list of participants from a LimeSurvey survey.

Usage

limer_get_participants(iSurveyID, iStart, iLimit, bUnused, aAttributes)

Arguments

Examples

## Not run: 
limer_get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE,
                                   aAttributes=c('attribute_1','attribute_2'))
limer_get_participants(12345, iStart=1, iLimit=10, bUnused=FALSE, aAttributes=FALSE)

## End(Not run)

Description

This function exports and downloads data from a LimeSurvey survey. It was adapted by Gjalt-Jorn Peters from a function originally written by Andrew Heiss.

Usage

limer_get_responses(
  iSurveyID,
  sDocumentType = "csv",
  sLanguageCode = NULL,
  sCompletionStatus = "complete",
  sHeadingType = "code",
  sResponseType = "long",
  encoding_limerCall = NULL,
  encoding_txtCon = NULL,
  ...
)

Arguments

Examples

## Not run: 
limer_get_responses(12345)

## End(Not run)

Description

This function clears the LimeSurvey API session key currently in use, effectively logging out. This function was adapted by Gjalt-Jorn Peters from a function originally written by Andrew Heiss.

Usage

limer_release_session_key()

Examples

## Not run: 
limesurvey::limer_release_session_key()

## End(Not run)

Description

To use this function, you need to setup R for the LimeSuevey API, as described in vignette("limesurvey_api_setup").

Usage

limer_upload_tsv_to_limesurvey(
  ls_txt_path,
  open_url = "preview",
  hostname = getOption("lime_api")
)

Arguments

Value

The value of the id of your survey in the specified LimeSurvey installation,

Examples

## Not run: 
### Log into the LimeSurvey API:
limonaid::get_session_key();

### Upload a tab separated values file:
limer_upload_tsv_to_limesurvey(
  "PATH/TO/YOUR/LIMESURVEY/TXT FILE",
  c("preview", "survey")
);

## End(Not run)

Description

This function applies specific code bits from the LimeSurvey data import R script, read by ls_parse_data_import_script(), for example to update variable names, set labels, etc.

Usage

ls_apply_script_bits(
  data,
  scriptBits,
  setVarNames = TRUE,
  setLabels = TRUE,
  convertToCharacter = FALSE,
  convertToFactor = FALSE,
  categoricalQuestions = NULL,
  massConvertToNumeric = TRUE,
  silent = limonaid::opts$get("silent"),
  sticky = limonaid::opts$get("sticky")
)

Arguments

Value

The dataframe.

Description

These are a set of really basic functions that facilitate building LimeSurvey Expression Manager (LSEM) equations.

Usage

ls_eq_build(lhs, operator, rhs)

ls_eq_is(varCode, value, naok = TRUE)

ls_eq_isChecked(varCode, naok = TRUE)

ls_eq_isUnchecked(varCode, naok = TRUE)

ls_eq_if(cond, ifExpr, elseExpr)

ls_eq_ifRegex(regex, varCode, ifExpr, elseExpr, naok = TRUE)

ls_eq_brace(expr)

ls_eq_quote(expr)

Arguments

Details

ls_eq_build() just pastes together its three arguments in the same order using a space as separator. So it's mostly used for clarity when building LSEM equations.

ls_eq_is() uses ls_eq_build() to specify a logical expression that is true when varCode equals value.

ls_eq_if() builds an if/then/else expression; if cond evaluates to TRUE, the LSEM uses ifExpr; otherwise, it uses elseExpr.

ls_eq_ifRegex checks a question against a regular expression.

ls_eq_isChecked() and ls_eq_isUnchecked() return an expression evaluating whether a checkbox is checked (or not).

ls_eq_brace() simply embraces expr, an expression (i.e. it prepends ⁠{⁠ and appends ⁠}⁠).

ls_eq_quote() simply embraces expr, an expression (i.e. it prepends ⁠'⁠ and appends ⁠'⁠).

Value

A character vector.

Examples

ls_eq_build("questionCode", "==", "Y");

Description

This function takes a series of conditions and corresponding values, and builds an equation consisting of nested if statements.

Usage

ls_eq_nestIfs(conditions, values, elseExpr, quoteValues = FALSE)

Arguments

Value

A character value.

Examples

### Relatively simple example with four levels of nesting
ls_eq_nestIfs(c("age.NAOK > 80",
                "age.NAOK > 65",
                "age.NAOK > 40",
                "age.NAOK > 20"),
              c("Respectable",
                "Roughly retired",
                "Roughly middle-aged",
                "Quite young"),
              "Very young",
              quoteValue=TRUE);

Description

This function can be used to import files exported by LimeSurvey.

Usage

ls_import_data(
  sid = NULL,
  path = NULL,
  datafile = NULL,
  dataPath = NULL,
  datafileRegEx = NULL,
  scriptfile = NULL,
  setVarNames = TRUE,
  setLabels = TRUE,
  convertToCharacter = FALSE,
  convertToFactor = FALSE,
  categoricalQuestions = NULL,
  massConvertToNumeric = TRUE,
  dataHasVarNames = TRUE,
  dataEncoding = "UTF-8-BOM",
  scriptEncoding = NULL,
  sticky = limonaid::opts$get("sticky"),
  silent = limonaid::opts$get("silent")
)

Arguments

Details

This function was intended to make importing data from LimeSurvey a bit easier. The default settings used by LimeSurvey are not always convenient, and this function provides a bit more control.

Value

The dataframe.

Examples

## Not run: 
### Of course, you need valid LimeSurvey files. This is an example of
### what you'd do if you have them, assuming you specified that path
### containing the data in 'dataPath', the name of the datafile in
### 'dataFileName', the name of the script file in 'dataLoadScriptName',
### and that you only want variables 'informedConsent', 'gender', 'hasJob',
### 'currentEducation', 'prevEducation', and 'country' to be converted to
### factors.
dat <- limonaid::ls_import_data(
  datafile = file.path(dataPath, dataFileName),
  scriptfile = file.path(dataPath, dataLoadScriptName),
  categoricalQuestions = c('informedConsent',
                           'gender',
                           'hasJob',
                           'currentEducation',
                           'prevEducation',
                           'country')
);

## End(Not run)

Description

This function extracts specific code bits from the LimeSurvey data import R script, which can then be applied to imported data using ls_apply_script_bits(), for example to update variable names, set labels, etc.

Usage

ls_parse_data_import_script(
  scriptfile = NULL,
  scriptEncoding = limonaid::opts$get("encoding"),
  silent = limonaid::opts$get("silent")
)

Arguments

Value

A list with four components.

Description

This function is meant to quickly parse the variable labels set by LimeSurvey. It works particularly well with dual anchor array questions, where the left and right anchors as well as the subquestions are extracted automatically.

Usage

ls_process_labels(
  data,
  varnameRegExPairs = NULL,
  lengthToWrap = 50,
  lengthToWrapAnchors = 20,
  labelExtractionRegExPair = limonaid::opts$get("labelExtractionRegExPair"),
  leftAnchorRegExPairs = limonaid::opts$get("leftAnchorRegExPairs"),
  rightAnchorRegExPairs = limonaid::opts$get("rightAnchorRegExPairs")
)

Arguments

Details

This function processes LimeSurvey variable labels and applies regular expressions to automatically extract subquestions and left and right anchors.

Value

A dataframe.

Examples

### No examples provided yet; this would require data to be included,
### and that's not available yet.

Description

Read a LimeSurvey Tab-Separated Values file

Usage

ls_read_tsv(file, encoding = limonaid::opts$get("encoding"))

Arguments

Value

A dataframe.

Examples

### Get location of one of the example files
exampleFile <-
  system.file(
    "extdata",
    "export-of-survey-with-one-question-as-tsv.txt",
    package = "limonaid"
  );

### Import file
lsrv <- limonaid::ls_read_tsv(exampleFile);

Description

This function takes a dataframe with LimeSurvey (LS) variable codes and values, and builds a nested set of LimeSurvey Equation Manager (LSEM) if/then/else equations where the variable code in each row (in the varCodeCol) is compared to the corresponding value (i.e. the value in the same row in the valueCol column) using the operator specified in that row in the operatorCol column (or the == operator, if no operator is specified). In the case of a match, the value in the corresponding recodeToCol column is returned. If there is no match, the comparison on the next row is evaluated, all the way down. If nothing matches, the elseExpr is returned.

Usage

ls_recodeTable_to_equations(
  data,
  varCodeCol = limonaid::opts$get("recTab2Eq_varCodeCol"),
  valueCol = limonaid::opts$get("recTab2Eq_valueCol"),
  recodeToCol = limonaid::opts$get("recTab2Eq_recodeToCol"),
  operatorCol = limonaid::opts$get("recTab2Eq_operatorCol"),
  elseExpr = limonaid::opts$get("eq_elseExpr"),
  naok = TRUE
)

Arguments

Value

A character value.

Examples

### Provide later

Description

Get all group rows from a LimeSurvey survey dataframe

Usage

ls_tsv_get_group_rows(data)

Arguments

Value

A dataframe with the rows.

Examples

### Add

Description

Display rows from a LimeSurvey dataframe that meet a criterion

Usage

ls_tsv_get_rows(data, ...)

Arguments

Value

The rows, passed through ls_tsv_rows().

Examples

### Add later

Description

Display one or more rows from a LimeSurvey dataframe, omitting empty columns

Usage

ls_tsv_rows(dfRows)

Arguments

Value

The rows, with empty columns omitted.

Examples

### Add later.

Description

Write a data frame to a LimeSurvey Tab Separated Values file

Usage

ls_write_lsg(
  data,
  file,
  encoding = limonaid::opts$get("encoding"),
  preventOverwriting = limonaid::opts$get("preventOverwriting"),
  silent = limonaid::opts$get("silent")
)

Arguments

Value

The dataframe, adapted for writing, invisibly.

Examples

### Add example once something is available.

Description

Write a data frame to a LimeSurvey Tab Separated Values file

Usage

ls_write_tsv(
  data,
  file,
  encoding = limonaid::opts$get("encoding"),
  preventOverwriting = limonaid::opts$get("preventOverwriting"),
  silent = limonaid::opts$get("silent")
)

Arguments

Value

The dataframe, adapted for writing, invisibly.

Examples

### Add example once something is available.

Description

This is used when exporting surveys to LimeSurvey's TSV format.

Usage

lsdf_for_language(
  language,
  groups,
  exportGroupIdMapping,
  exportQuestionIdMapping,
  backupLanguage,
  silent = limonaid::opts$get("silent")
)

Arguments

Value

Invisibly, the Survey object.

Description

This function was adapted by Gjalt-Jorn Peters from a function originally written by Andrew Heiss.

Usage

mail_registered_participant(iSurveyID, tid)

Arguments

Examples

## Not run: 
limonaid::mail_registered_participant(iSurveyID = 123456, tid = 2)

## End(Not run)

Description

This function makes it easy to convert many dataframe columns to numeric.

Usage

massConvertToNumeric(
  dat,
  byFactorLabel = FALSE,
  ignoreCharacter = TRUE,
  stringsAsFactors = FALSE
)

Arguments

Value

A data.frame.

Examples

### Create a dataset
a <- data.frame(var1 = factor(1:4),
                var2 = as.character(5:6),
                stringsAsFactors=FALSE);

### Ignores var2
b <- massConvertToNumeric(a);

### Converts var2
c <- massConvertToNumeric(a,
                          ignoreCharacter = FALSE);

Description

The limonaid::opts object contains three functions to set, get, and reset options used by the escalc package. Use limonaid::opts$set to set options, limonaid::opts$get to get options, or limonaid::opts$reset to reset specific or all options to their default values.

Usage

opts

Format

An object of class list of length 4.

Details

It is normally not necessary to get or set limonaid options.

The following arguments can be passed:

...

For limonaid::opts$set, the dots can be used to specify the options to set, in the format option = value, for example, silent = FALSE. For limonaid::opts$reset, a list of options to be reset can be passed.

option

For limonaid::opts$set, the name of the option to set.

default

For limonaid::opts$get, the default value to return if the option has not been manually specified.

The following options can be set:

silent

Whether to be chatty or silent.

encoding

The encoding to use when writing files.

preventOverwriting

The name of the column with the missing values.

Examples

### Get the default silent setting
limonaid::opts$get('silent');

### Set it to FALSE
limonaid::opts$set(silent = FALSE);

### Check that it worked
limonaid::opts$get('silent');

### Reset this option to its default value
limonaid::opts$reset('silent');

### Check that the reset worked, too
limonaid::opts$get('silent');

Description

This function makes it easy to parse the dropouts from a LimeSurvey questionnaire.

Usage

processLimeSurveyDropouts(lastpage, pagenames = NULL, relevantPagenames = NULL)

Arguments

Details

This will be described more in detail in a forthcoming publications.

Value

A list with information about the dropout, including plots.

Examples

limonaid::processLimeSurveyDropouts(c(1,2,1,1,2,3,2,2,3,2,1));

Description

R6 Class representing a LimeSurvey question

R6 Class representing a LimeSurvey question

Details

A question has at least a code and a primary language.

The human-readable question types are (with some additional variants also being valid, in any case the literal labels used at https://www.limesurvey.org/manual/Question_object_types#Current_question_types):

• "⁠array dual scale⁠"

• "⁠5 point choice⁠"

• "⁠5 point array⁠"

• "⁠10 point array⁠"

• "⁠yes/no/uncertain array⁠"

• "date"

• "⁠increase/same/decrease array⁠"

• "array" (this is the "⁠array (flexible labels)⁠" type)

• "gender"

• "⁠array by column⁠"

• "⁠language switch⁠"

• "⁠multiple numerical input⁠",

• "radio" (this is the "list" type)

• "checkboxes" (this is the "⁠multiple choice⁠" type)

• "⁠numerical input⁠",

• "⁠list with comment⁠"

• "⁠multiple choice with comments⁠"

• "⁠multiple short text⁠"

• "ranking"

• "⁠short text⁠"

• "⁠long text⁠"

• "⁠huge text⁠"

• "⁠text display⁠"

• "yes/no"

• "⁠multiple texts array⁠",

• "⁠multiple dropdown array⁠"

• "file"

• "dropdown"

• "equation".

Public fields

Active bindings

Methods

Public methods

• Question$new()

• Question$add_answer_option()

• Question$add_subquestion()

• Question$xmlExport_row_question()

• Question$xmlExport_row_subquestions()

• Question$xmlExport_row_question_l10ns()

• Question$xmlExport_row_answers()

• Question$xmlExport_row_answer_l10ns()

• Question$xmlExport_row_attributes()

• Question$clone()

Method new()

Create a new question 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

Question$new(
  code,
  type = NULL,
  lsType = NULL,
  id = NULL,
  gid = NULL,
  sid = NULL,
  questionTexts = "",
  helpTexts = "",
  relevance = 1,
  validation = "",
  mandatory = "N",
  parent_qid = 0,
  other = "N",
  otherReplaceTexts = "",
  default = "",
  same_default = "0",
  array_filter = "",
  cssclass = "",
  hide_tip = "",
  language = "en",
  additional_languages = "",
  new_id_fun = NULL,
  question_order = 0,
  ...
)

Arguments

Returns

A new Question object.

Method add_answer_option()

Add an answer option to a question. 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

Question$add_answer_option(
  code,
  optionTexts,
  type.scale = 0,
  relevance = "",
  assessment.value = 0,
  sort.order = NULL
)

Arguments

Returns

Invisibly, the question object.

Method add_subquestion()

Add a subquestion to a question. 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

Question$add_subquestion(
  code,
  subquestionTexts,
  relevance = "",
  helpTexts = NULL,
  type.scale = 0,
  validation = "",
  mandatory = "",
  default = "",
  same_default = "",
  subquestion.order = NULL
)

Arguments

Returns

Invisibly, the question object.

Method xmlExport_row_question()

Export the question in XML format (for lss, lsg, or lsq files).

Usage

Question$xmlExport_row_question(silent = limonaid::opts$get("silent"))

Arguments

Returns

The produced XML

Method xmlExport_row_subquestions()

Export the question in XML format (for lss, lsg, or lsq files).

Usage

Question$xmlExport_row_subquestions(
  returnRows = FALSE,
  silent = limonaid::opts$get("silent")
)

Arguments

Returns

The produced XML

Method xmlExport_row_question_l10ns()

Export the question's question_l10ns info in a list of XML nodes.

Usage

Question$xmlExport_row_question_l10ns(
  id_fun = private$new_id(),
  silent = limonaid::opts$get("silent")
)

Arguments

Returns

The produced list of XML nodes

Method xmlExport_row_answers()

Export the answer options in XML format (for lss, lsg, or lsq files).

Usage

Question$xmlExport_row_answers(
  returnRows = FALSE,
  silent = limonaid::opts$get("silent")
)

Arguments

Returns

The produced XML

Method xmlExport_row_answer_l10ns()

Export the question's answer optoin l10ns info in a list of XML nodes.

Usage

Question$xmlExport_row_answer_l10ns(
  id_fun = private$new_id,
  silent = limonaid::opts$get("silent")
)

Arguments

Returns

The produced list of XML nodes

Method xmlExport_row_attributes()

Export the question's attributes in a list of XML nodes.

Usage

Question$xmlExport_row_attributes(silent = limonaid::opts$get("silent"))

Arguments

Returns

The produced list of XML nodes

Method clone()

The objects of this class are cloneable with this method.

Usage

Question$clone(deep = FALSE)

Arguments

Description

Repeat a string a number of times

Usage

repeatStr(n = 1, str = " ")

Arguments

Value

A character vector of length 1.

Examples

### 10 spaces:
repStr(10);

### Three euro symbols:
repStr("\u20ac", 3);

Description

R6 Class representing a LimeSurvey survey

R6 Class representing a LimeSurvey survey

Details

Create and work with a Survey to programmatically (or interactively) create a survey, export it to a tab separated values file, and import it to LimeSurvey.

Public fields

Active bindings

Methods

Public methods

• Survey$new()

• Survey$add_group()

• Survey$add_question()

• Survey$export_to_tsv()

• Survey$find_group_id()

• Survey$clone()

Method new()

Create a new survey object.

Usage

Survey$new(
  titles,
  descriptions = "",
  welcomeTexts = "",
  endTexts = "",
  endURLs = "",
  endURLdescriptions = "",
  dateformats = 6,
  numberformats = 0,
  sid = 1,
  gsid = 1,
  admin = "Admin Name",
  adminemail = "[email protected]",
  anonymized = "Y",
  faxto = "",
  format = "G",
  savetimings = "Y",
  template = "vanilla",
  language = "en",
  additional_languages = "",
  datestamp = "Y",
  usecookie = "N",
  allowregister = "N",
  allowsave = "N",
  autonumber_start = 0,
  autoredirect = "Y",
  allowprev = "N",
  printanswers = "N",
  ipaddr = "N",
  refurl = "N",
  showsurveypolicynotice = "0",
  publicstatistics = "N",
  publicgraphs = "N",
  listpublic = "N",
  htmlemail = "Y",
  sendconfirmation = "N",
  tokenanswerspersistence = "N",
  assessments = "N",
  usecaptcha = "N",
  usetokens = "N",
  bounce_email = "",
  emailresponseto = "",
  emailnotificationto = "",
  tokenlength = 15,
  showxquestions = "N",
  showgroupinfo = "X",
  shownoanswer = "N",
  showqnumcode = "X",
  bounceprocessing = "N",
  showwelcome = "N",
  showprogress = "N",
  questionindex = "0",
  navigationdelay = "0",
  nokeyboard = "N",
  alloweditaftercompletion = "N",
  googleanalyticsstyle = 0,
  googleanalyticsapikey = "",
  new_id_fun = NULL
)

Arguments

Returns

A new Survey object.

Method add_group()

Add a group to a survey object.

Usage

Survey$add_group(titles, descriptions = "", relevance = 1, random_group = "")

Arguments

Returns

Invisibly, the Survey object.

Method add_question()

Add a question to a survey object.

Usage

Survey$add_question(groupId, code, type = NULL, lsType = NULL, ...)

Arguments

Returns

Invisibly, the Survey object.

Method export_to_tsv()

Export the survey as a tab separated values file (see https://manual.limesurvey.org/Tab_Separated_Value_survey_structure).

Usage

Survey$export_to_tsv(
  file,
  preventOverwriting = limonaid::opts$get("preventOverwriting"),
  parallel = TRUE,
  encoding = limonaid::opts$get("encoding"),
  silent = limonaid::opts$get("silent"),
  backupLanguage = self$language
)

Arguments

Returns

Invisibly, the Survey object.

Method find_group_id()

Find the numeric group identifier by group title.

Usage

Survey$find_group_id(title, titleLanguage = NULL)

Arguments

Returns

Invisibly, the Survey object.

Method clone()

The objects of this class are cloneable with this method.

Usage

Survey$clone(deep = FALSE)

Arguments

Description

Returns a list of lists, where each list contains a row.

Usage

transpose_df(x)

Arguments

Value

A list.

Examples

limonaid::transpose_df(
  mtcars[1:3, 1:3]
);

Description

Easily parse a vector into a character value

Usage

vecTxt(
  vector,
  delimiter = ", ",
  useQuote = "",
  firstDelimiter = NULL,
  lastDelimiter = " & ",
  firstElements = 0,
  lastElements = 1,
  lastHasPrecedence = TRUE
)

vecTxtQ(vector, useQuote = "'", ...)

Arguments

Value

A character vector of length 1.

Examples

vecTxtQ(names(mtcars));