R/demo.R

In klausfrieler/SMT: Seashore Measures of Musical Talents

#' Demo SMT
#'
#' This function launches a demo for the SMT.
#'
#' @param num_items (Integer scalar) Number of items in the test.
#' @param with_interim_feedback (Scalar boolean) Indicates, if feedback after each task group shall be given
#' @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{longgoldstudy@gmail.com},
#' 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"}) and German (\code{"de"}..
#' The first language is selected by default
#' @param ... Further arguments to be passed to \code{\link{SMT}()}.
#' @export
#'
SMT_demo <- function(num_items = 3L,
                     with_interim_feedback = TRUE,
                     feedback = SMT::SMT_feedback_with_graph(),
                     admin_password = "demo",
                     researcher_email = "longgoldstudy@gmail.com",
                     dict = SMT::SMT_dict,
                     language = "en",
                     ...) {
  elts <- psychTestR::join(
    SMT_welcome_page(dict = dict),
    SMT::SMT(max_items_per_task = num_items,
             with_welcome = FALSE,
             with_finish = FALSE,
             with_selection = TRUE,
             with_interim_feedback = with_interim_feedback,
             feedback = feedback,
             dict = dict,
             ...),
      SMT_final_page(dict = dict)
  )

  psychTestR::make_test(
    elts,
    opt = psychTestR::test_options(title = "Seashore Measures of Musical Talents Demo",
                                   admin_password = admin_password,
                                   researcher_email = researcher_email,
                                   demo = TRUE,
                                   languages = tolower(language)))
}