R/layer-list.R

Defines functions flatten_layer_list as_layer_list.LayerInstance as_layer_list.list as_layer_list.layer_list as_layer_list layer_list new_layer_list

Documented in as_layer_list as_layer_list.LayerInstance as_layer_list.layer_list as_layer_list.list layer_list

new_layer_list = function(list) {
  new("layer_list", .Data = list)
}

#' @rdname layer_list
#' @export
layer_list = function(...) {
  new_layer_list(list(...))
}


# type conversion ---------------------------------------------------------

#' @rdname layer_list
#' @export
as_layer_list = function(x) {
  UseMethod("as_layer_list")
}

#' @rdname layer_list
#' @export
as_layer_list.layer_list = function(x) {
  x
}

#' @rdname layer_list
#' @export
as_layer_list.list = function(x) {
  if (!is_layer_like(x)) {
    stop0("All objects in a layer_list must be layer-like objects")
  }
  new_layer_list(as.list(x))
}

#' @rdname layer_list
#' @export
as_layer_list.LayerInstance = function(x) {
  new_layer_list(list(x))
}


# layer concatenation -------------------------------------------------

#' @rdname layer_list
#' @export
setMethod("+", signature(e1 = "layer_list", e2 = "layer_list"), function(e1, e2) {
  new_layer_list(c(e1, e2))
})


# layer list flattening ---------------------------------------------------

#' Flatten a list of layers so that nested lists of layers (a la list(..., ..., list(...)))
#' are flattened into a single level. Unlike unlist(), does not remove type information
#' of list elements / try to coerce everything to the same vector type
#' @noRd
flatten_layer_list = function(layers) {
  if (is.list(layers)) {
    do.call(c, lapply(layers, flatten_layer_list))
  } else {
    list(layers)
  }
}


# printing ----------------------------------------------------------------

#' @rdname layer_list
#' @export
setMethod("show", signature(object = "layer_list"), function(object) {
  cat("<layer_list>:\n")
  print(object@.Data)
})

Try the ggblend package in your browser

Any scripts or data that you put into this service are public.

ggblend documentation built on May 31, 2023, 8:25 p.m.