R/magpiesort.R

In magclass: Data Class and Tools for Handling Spatial-Temporal Data

#' MAgPIE-Sort
#'
#' Brings the spatial and temporal structure of MAgPIE objects in the right
#' order. This function is especially useful when you create new MAgPIE objects
#' as the order typically should be correct for MAgPIE objects.
#'
#'
#' @param x MAgPIE object which might not be in the right order.
#' @return The eventually corrected MAgPIE object (right order in spatial in
#' temporal dimension)
#' @author Jan Philipp Dietrich
#' @seealso \code{"\linkS4class{magpie}"}
#' @examples
#'
#' pop <- maxample("pop")
#' a <- magpiesort(pop)
#' @export magpiesort
magpiesort <- function(x) {
  if (!is.magpie(x)) stop("Input is not a MAgPIE object!")
  if (dim(x)[1] == 1) {
    spatial_order <- 1
  } else if (length(grep("\\.[0-9]*$", dimnames(x)[[1]])) == dim(x)[1]) {
    spatial_order <- order(as.numeric(gsub("^.*\\.", "", dimnames(x)[[1]])))
  } else {
    spatial_order <- order(dimnames(x)[[1]])
  }
  if (!is.null(dimnames(x)[[2]])) temporal_order <- order(dimnames(x)[[2]])
  else temporal_order <- 1:dim(x)[2]
  return(x[spatial_order, temporal_order, ])
}