R/nlist.R

In nlist: Lists of Numeric Atomic Objects

#' Create nlist Object
#'
#' Creates a [nlist_object()] from one of more uniquely named numeric arguments.
#'
#' An nlist object is an S3 class list of uniquely named
#' numeric elements.
#'
#' nlist objects are the raw data inputs for analytic engines
#' such as JAGS, STAN and TMB.
#' @param ... Uniquely named numeric objects.
#' @return An nlist object.
#' @aliases nlist-object nlist_object
#' @seealso [nlists()]
#' @export
#'
#' @examples
#' nlist()
#' nlist(x = 1)
#' nlist(y = 1:4, zz = matrix(1:9, 3))
nlist <- function(...) {
  args <- list(...)
  if (length(args)) {
    return(as_nlist(args))
  }
  structure(list(), .Names = character(0), class = "nlist")
}