R/standalone.R

In fmhoeger/MIQ: My IQ Test (MIQ)

#' Standalone MIQ
#'
#' This function launches a standalone testing session for MIQ.
#' This can be used for data collection, either in the laboratory or online.
#'
#' @param title (Character scalar) Title to display during testing.
#' @param num_items (Integer scalar) Number of items to be adminstered.
#' @param with_welcome (Logical scalar) Whether to display a welcome page.
#' Defaults to TRUE.
#' @param take_training (Logical scalar) Defines whether instructions and training are included.
#' Defaults to TRUE.
#' @param feedback_page (Function) Defines a feedback page function for displaying
#' the results to the participant at the end of the test. Defaults to NULL.
#' Possible feedback page functions include \code{"feedback_with_score()"}, and
#' \code{"feedback_with_graph()"}.
#' @param admin_password (Character scalar) Password for accessing the admin panel.
#' @param researcher_email (Character scalar)
#' If not \code{NULL}, this researcher's email address is displayed
#' at the bottom of the screen so that online participants can ask for help.
#' @param languages (Character vector)
#' Determines the languages available to participants.
#' Possible languages include English (\code{"en"}), and German (\code{"de"}).
#' The first language is selected by default
#' @param dict (i18n_dict) The psychTestR dictionary used for internationalisation.
#' @param validate_id (Character scalar or closure) Function for validating IDs
#' or string "auto" for default validation which means ID should consist only of
#' alphanumeric characters.
#' @param ... Further arguments to be passed to \code{\link{MIQ_standalone}()}.
#' @export
MIQ_standalone  <- function(title = NULL,
                            num_items = 5,
                            with_welcome = TRUE,
                            take_training = TRUE,
                            feedback_page = NULL,
                            admin_password = "conifer",
                            researcher_email = "longgold@gold.uc.ak",
                            languages = c("en", "de"),
                            dict = MIQ::MIQ_dict,
                            validate_id = "auto",
                            ...) {

  elts <- c(
    psychTestR::new_timeline(
      psychTestR::get_p_id(prompt = psychTestR::i18n("ENTER_ID"),
                           button_text = psychTestR::i18n("CONTINUE"),
                           validate = validate_id),
      dict = dict
    ),
    MIQ(num_items = num_items,
        take_training = take_training,
        with_welcome =  with_welcome,
        feedback_page = feedback_page,
        ...),
    psychTestR::elt_save_results_to_disk(complete = TRUE),
    psychTestR::new_timeline(
      psychTestR::final_page(shiny::p(
        psychTestR::i18n("RESULTS_SAVED"),
        psychTestR::i18n("CLOSE_BROWSER"))
      ), dict = dict)
  )

  title <-
    unlist(setNames(
      purrr::map(MIQ::MIQ_languages(), function(x)
        MIQ::MIQ_dict$translate("TITLE", x)),
      MIQ::MIQ_languages()
    ))

  psychTestR::make_test(
    elts,
    opt = psychTestR::test_options(title = title,
                                   admin_password = admin_password,
                                   researcher_email = researcher_email,
                                   demo = FALSE,
                                   languages = languages))
}