R/metaclipcc.HorizontalExtent.R

In metaclip/metaclipcc: METACLIP for the IPCC-AR6 Interactive Atlas

##     metaclipcc.HorizontalExtent Construct a directed graph defining a reference SpatialExtent
##
##     Copyright (C) 2020 Santander Meteorology Group (http://www.predictia.es)
##
##     This program is free software: you can redistribute it and/or modify
##     it under the terms of the GNU General Public License as published by
##     the Free Software Foundation, either version 3 of the License, or
##     (at your option) any later version.
##
##     This program is distributed in the hope that it will be useful,
##     but WITHOUT ANY WARRANTY; without even the implied warranty of
##     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
##     GNU General Public License for more details.
##
##     You should have received a copy of the GNU General Public License
##     along with this program.  If not, see <http://www.gnu.org/licenses/>.


#' @title Set a reference SpatialExtent
#' @description Creates a graph containing a SpatialExtent definition, that can be used later as spatial reference of
#' subsetting, regridding operations etc. so all steps point to the same reference spatial extent
#' @param region Character string designating a known region.
#' @param xmin xmin
#' @param xmax xmax
#' @param ymin ymin
#' @param ymax ymax
#' @param dc.description Default to \code{NULL} and unused. Otherwise, this is a character string that will be appendend as a
#'  "dc:description" annotation to the ds:HorizontalExtent-class node. Unused if a valid \code{region} is supplied
#' @return A metaclipR list (igraph-class structure + terminal node name)
#' @importFrom igraph make_empty_graph add_vertices
#' @author J Bedia
#' @export


metaclipcc.HorizontalExtent <- function(region = NULL,
                                        xmin = NULL,
                                        xmax = NULL,
                                        ymin = NULL,
                                        ymax = NULL,
                                        dc.description = NULL) {
    # Comprueba individuos para name
    graph <- make_empty_graph()
    if (!is.null(region)) {
        spatextent.nodename <- paste0("ds:", region)
        graph <- add_vertices(graph,
                              nv = 1,
                              name = spatextent.nodename,
                              label = paste(region, "region", sep = "_"),
                              className = "ds:HorizontalExtent")
    } else {
        if (anyNA(c(xmin, xmax, ymin, ymax))) stop("Required bbox coordinates are missing")
        spatextent.nodename <- paste("SpatialExtent", randomName(), sep = ".")
        attr.list <- list("ds:xmin" = xmin,
                          "ds:xmax" = xmax,
                          "ds:ymin" = ymin,
                          "ds:ymax" = ymax)
        if (!is.null(dc.description)) {
            attr.list[["dc:description"]] <-  dc.description
        }
        graph <- add_vertices(graph,
                              nv = 1,
                              name = spatextent.nodename,
                              label = "HorizontalExtent",
                              className = "ds:HorizontalExtent",
                              attr = attr.list)
    }
    return(list("graph" = graph, "parentnodename" = spatextent.nodename))
}