R/statement.R

In rpc5102/rlocker: Learning Locker for Shiny

#' statement
#' 
#' xAPI Statement object creation functions
#' @importFrom uuid UUIDgenerate
#' @name statement
NULL

#' Creates an xAPI Statement
#' 
#' @param stmt Statement values
#' @param warn Show warnings
#' 
#' @examples
#' createStatement(
#'   stmt = list(
#'     agent = list(
#'       name = "John Doe",
#'       mbox = "mailto:john@example.com"
#'     ),
#'     verb = list(
#'       display = "answered",
#'       id = "http://adlnet.gov/expapi/verbs/answered"
#'     ),
#'     object = list(
#'       name = "Question 1",
#'       description = "Example question description."
#'     ),
#'     result = list(
#'       success = TRUE,
#'       response = "correctAnswer",
#'       extensions = list(
#'         ref = "https://w3id.org/xapi/cmi5/result/extensions/progress",
#'         value = 100
#'       )
#'     )
#'   )
#' )
#' 
#' @seealso \code{\link{createAgent}}
#' @seealso \code{\link{createVerb}}
#' @seealso \code{\link{createObject}}
#' @seealso \code{\link{createResult}}
#' 
#' @return xAPI Statement (json)
#' 
#' @export
createStatement <- function(stmt = NULL, warn = FALSE, ...) {

  if (is.null(stmt)) {
    warning("No arguments specified; using default xapi:statement.", call. = FALSE)
    warn <- FALSE
  }

  # Required
  statement <- list(
    actor = do.call(createActor, list(agent = stmt$agent, group = stmt$group, warn = warn)),
    verb = do.call(createVerb, list(verb = stmt$verb, warn = warn)),
    object = do.call(createObject, list(object = stmt$object, warn = warn))
  )

  # Optional
  if (!is.null(stmt$result)) {
    statement$result <- do.call(createResult, list(result = stmt$result, warn = warn))
  }

  return(formatJSON(statement, pretty = TRUE, auto_unbox = TRUE))
}