R/timeline.R

In smbache/dairy: Let R Remember the Milk

#' Get or Create a new Timeline
#'
#' A new timeline will be created if no existing timeline exists. If it
#' does exist and \code{new = FALSE} then the existing timeline is returned.
#'
#' @param new logical indicating whether a new timeline should be created.
#'
#' @export
get_timeline <- local({

  .timeline <- NULL

  function(new = FALSE)
  {
    if (!new && !is.null(.timeline))
      return(.timeline)

    .timeline <<- quairy("rtm.timelines.create")[["rsp"]][["timeline"]]

    if (!quairy_status(.timeline)) {
      .timeline <<- NULL
      stop("Failed to obtain a timeline.", call. = FALSE)
    }

    .timeline
  }
})