R/demo.R

In klausfrieler/RAT: Musical Rhythm Ability Test

#' Demo RAT
#'
#' This function launches a demo for the RAT.
#'
#' @param num_items (Integer scalar) Number of items in the test.
#' @param take_training (Boolean scalar) Defines whether instructions and training are included.
#' Defaults to TRUE.
#' @param feedback (Function) Defines the feedback to give the participant
#' at the end of the test. Defaults to a graph-based feedback page.
#' @param admin_password (Scalar character) Password for accessing the admin panel.
#' Defaults to \code{"demo"}.
#' @param researcher_email (Scalar character)
#' 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.
#' Defaults to \email{longgold@gold.uc.ak},
#' the email address of this package's developer.
#' @param dict The psychTestR dictionary used for internationalisation.
#' @param language The language you want to run your demo in.
#' Possible languages include English (\code{"en"}), German (informal \code{"de"}, formal \code{"de_f"}), Latvian \code{"lv"}, and Italian (\code{"it"}).
#' The first language is selected by default
#' @param ... Further arguments to be passed to \code{\link{RAT}()}.
#' @export
RAT_demo <- function(num_items = 3L,
                     take_training = TRUE,
                     feedback = RAT::RAT_feedback_with_score(),
                     admin_password = "demo",
                     researcher_email = "longgold@gold.uc.ak",
                     dict = RAT::RAT_dict,
                     language = "en",
                     ...) {
  elts <- c(
    psychTestR::new_timeline(psychTestR::one_button_page(
      body = psychTestR::i18n("WELCOME"),
      button_text = psychTestR::i18n("CONTINUE")
    ), dict = dict),
    RAT::RAT(num_items = num_items,
             take_training = take_training,
             feedback = feedback,
             dict = dict,
             ...),
    psychTestR::new_timeline(
      psychTestR::final_page(psychTestR::i18n("CLOSE_BROWSER")),
      dict = dict
    )
  )

  psychTestR::make_test(
    elts,
    opt = psychTestR::test_options(title = "Musical Rhythm Test Demo",
                                   admin_password = admin_password,
                                   researcher_email = researcher_email,
                                   demo = TRUE,
                                   languages = language))
}