R/ncells.R

Defines functions ncells

Documented in ncells

#' Count elements
#'
#' Functions to count the number of cells/years/datasets/regions of an
#' MAgPIE-object
#'
#' @aliases ncells nyears ndata nregions
#' @param x A MAgPIE-object
#' @return \item{value}{The number of cells/years/datasets/regions of \code{x}}
#' @author Jan Philipp Dietrich
#' @examples
#'
#' a <- is.magpie(NULL)
#' ncells(a)
#' nyears(a)
#' ndata(a)
#' nregions(a)
#' @export
ncells <- function(x) {
  return(dim(x)[1])
}
pik-piam/magclass documentation built on March 25, 2024, 11:07 p.m.