Add the base maps as data sets loadable with data()

Author: rplzzz

R/gcammaptools.R

@@ -52,3 +52,39 @@
 #' @import ggplot2
 #' @importFrom magrittr %>%
 NULL
+
+#' Base map for 14-region GCAM
+#'
+#' This is the region map used in versions of GCAM prior to GCAM 4.0.  It is
+#' largely obsolete, but there are still some data from those days floating
+#' around in the wild
+#'
+#' @format Spatial data frame
+"map.rgn14"
+
+#' Base map for 32-region GCAM
+#'
+#' This is the region map used in GCAM 4.0 and subsequent.  This version of the
+#' map does not include the Taiwan region.
+#'
+#' @format Spatial data frame
+"map.rgn32"
+
+#' Base map for 235 global water basins
+#'
+#' This is the map of the 235 global water basins.  For compatibility with the
+#' other map data frames it refers to the basins as "regions".  Thus, any GCAM
+#' data with a "basin" column will need to have a "region" column added.  There
+#' is also some variability in how the basin names are represented, so this data
+#' set will need some work.
+#'
+#' @format Spatial data frame
+"map.basin235"
+
+#' Base map for 32-region GCAM with China subregions
+#'
+#' This map has the 32 GCAM regions, plus the subregions corresponding to
+#' China's provinces, municipalities, autonomous regions, and SARs.
+#'
+#' @format Spatial data frame
+"map.chn"

data-raw/gen-maps.R

@@ -0,0 +1,21 @@
+### Run this script in an interactive session and call \code{devtools::use_data}
+### on the resulting outputs.  It assumes you are at the package top level
+### directory.
+
+library('magrittr')
+
+load.geojson <- function(file, property) {
+    map <- rgdal::readOGR(file) %>% ggplot2::fortify(region=property)
+}
+
+gen.data <- function() {
+    map.rgn14 <- load.geojson('inst/extdata/rgn14/GCAM_region.geojson', 'GCAM_regio')
+    map.rgn32 <- load.geojson('inst/extdata/rgn32/GCAM_32_wo_Taiwan_clean.geojson', 'GCAM_ID')
+    map.basin235 <- load.geojson('inst/extdata/rgnbasin/Global235_CLM_05_dissolve.geojson', 'GCAM_ID_1')
+    map.chn <- load.geojson('inst/extdata/rgnchn/GCAM_China.geojson', 'GCAM_ID')
+    ## TODO:  add GCAM-USA dataset here
+
+    devtools::use_data(map.rgn14, map.rgn32, map.basin235, map.chn)
+}
+
+gen.data()