R/build_timeline.R

In djnavarro/jaysire: Build jsPsych Experiments in R

# file: timeline_build.R
# author: Danielle Navarro

#' Build a timeline from trials
#'
#' @param ... trial objects to add to this timeline
#'
#' @return An object of class "timeline"
#'
#' @details Experiments in jsPsych are specified in terms of a "timeline"
#' object, where each timeline can consist of one or more "trial" objects
#' and timelines can contain other timelines. In pure jsPsych it is possible
#' to define a "bare" trial that is not contained within a timeline (the trial
#' is essentially a timeline) but jaysire is slightly more restrictive. To
#' build a timeline in jaysire, the output of \code{trial_} functions need to be
#' passed through the \code{build_timeline()} function to create a properly
#' constructed timeline object.
#'
#' Once constructed, behaviour and execution of a timeline can be modified
#' using a variety of functions. A timeline can be looped using the
#' \code{\link{display_while}()} function, or executed contiionally using
#' the \code{\link{display_if}()} function. Timeline variables can be attached
#' using \code{\link{set_variables}()} and other parameters can be passed to
#' the timeline using \code{\link{set_parameters}()}.
#'
#' @export
build_timeline <- function(...){
  tl <- list(timeline = list(...))
  class(tl) <- c("timeline", "list")
  tl
}