R/data.R

In abbey-thomas/speechcollectr: R Tools for Collecting Speech Production & Perception Data

#' A sample of white noise
#'
#' A 10 second sample of white noise useful for presenting to the user for headphone volume calibration in a shiny app.
#'
#' @format A Wave object (for more information, see `tuneR::readWave()` documentation) containing a 10 second sample of white noise sampled at 44.1 kHz.
#'
#' @source \url{https://github.com/ChaitLabUCL/HeadphoneCheck_Test}
#' @import tuneR
"cal_noise"

#' Basic Demographic Survey Questions.
#'
#' A data frame containing a correctly formatted basic demographic questionnaire, for use with the `speechcollectr::survey*()` functions.
#'
#' @format A data frame with 7 rows (corresponding to 7 survey questions) and 5 variables:
#' \describe{
#'   \item{id}{A unique input ID for each question}
#'   \item{label}{Labels (i.e., the questions) that will be displayed to participants}
#'   \item{priority}{Specifies whether an answer to a given question is required or not.}
#'   \item{type}{Type of shiny input function to use for each question.}
#'   \item{options}{Contains the list of options for all non-textInput questions.}
#'
#' }
"demographics"

#' Sample audio recording
#'
#' A recording of a single interrogative utterance by a male British English speaker. From the Librivox recording of \emph{The Wisdom of Father Brown} by G.K. Chesterton.
#'
#' @format A tuneR::Wave object.
#' @source \url{https://librivox.org/the-wisdom-of-father-brown-by-g-k-chesterton/}
"samp_wav"

#' Questions for checking participant qualifications.
#'
#' A data frame containing a correctly formatted set of questions, for use with the `speechcollectr::check*()` functions.
#'
#' @format A data frame with 7 rows (corresponding to 7 survey questions) and 5 variables:
#' \describe{
#'   \item{id}{A unique input ID for each question}
#'   \item{label}{Labels (i.e., the questions) that will be displayed to participants}
#'   \item{priority}{Specifies whether an answer to a given question is required or not.}
#'   \item{error}{If an item is required, specifies the error message that will be displayed to participants if answered with FALSE.}
#'
#' }
"qualifications"