Merge pull request #34 from BroVic/dev

Update to 0.4.2

Author: BroVic

DESCRIPTION

@@ -1,41 +1,42 @@
-Package: naijR
-Type: Package
-Title: Operations to Ease Data Analyses Specific to Nigeria
-Version: 0.4.1.9004
-Date: 2022-02-18
-Depends: 
-    R (>= 3.6),
-    methods,
-    utils
-Imports:
-    RColorBrewer (>= 1.1.2),
-    lifecycle (>= 0.2.0),
-    magrittr (>= 1.5),
-    mapdata (>= 2.3.0),
-    maps (>= 3.3.0),
-    rgdal (>= 1.4.4),
-    rlang (>= 0.4.0)
-Suggests: 
-    covr,
-    here,
-    knitr,
-    readxl,
-    rmarkdown,
-    sp (>= 1.4.2),
-    testthat,
-    usethis
-Authors@R: person("Victor", "Ordu", 
-              email = "victorordu@outlook.com",
-              role = c("aut", "cre"),
-              comment = c(ORCID = "0000-0003-3716-0668"))
-Description: A set of convenience functions as well as geographical/political
-  data about Nigeria, aimed at simplifying work with data and information that
-  are specific to the country.
-License: GPL-3
-LazyData: TRUE
-Encoding: UTF-8
-RoxygenNote: 7.1.1
-VignetteBuilder: knitr
-RdMacros: lifecycle
-URL: https://brovic.github.io/naijR/
-BugReports: https://github.com/BroVic/naijR/issues
+Package: naijR
+Type: Package
+Title: Operations to Ease Data Analyses Specific to Nigeria
+Version: 0.4.2
+Date: 2022-07-18
+Depends: 
+    R (>= 3.6),
+    grDevices,
+    methods,
+    utils
+Imports:
+    RColorBrewer (>= 1.1.2),
+    lifecycle (>= 0.2.0),
+    magrittr (>= 1.5),
+    mapdata (>= 2.3.0),
+    maps (>= 3.3.0),
+    rgdal (>= 1.4.4),
+    rlang (>= 0.4.0)
+Suggests: 
+    covr,
+    here,
+    knitr,
+    readxl,
+    rmarkdown,
+    sp (>= 1.4.2),
+    testthat,
+    usethis
+Authors@R: person("Victor", "Ordu", 
+              email = "victorordu@outlook.com",
+              role = c("aut", "cre"),
+              comment = c(ORCID = "0000-0003-3716-0668"))
+Description: A set of convenience functions as well as geographical/political
+  data about Nigeria, aimed at simplifying work with data and information that
+  are specific to the country.
+License: GPL-3
+LazyData: TRUE
+Encoding: UTF-8
+RoxygenNote: 7.1.2
+VignetteBuilder: knitr
+RdMacros: lifecycle
+URL: https://brovic.github.io/naijR/
+BugReports: https://github.com/BroVic/naijR/issues

NAMESPACE

@@ -22,6 +22,7 @@ import(mapdata)
 import(stats)
 importFrom(RColorBrewer,brewer.pal)
 importFrom(RColorBrewer,brewer.pal.info)
+importFrom(grDevices,colours)
 importFrom(grDevices,palette)
 importFrom(graphics,legend)
 importFrom(graphics,par)

NEWS.md

@@ -1,3 +1,10 @@
+# naijR 0.4.2
+* Improved type checking for mapping functionality and better fidelity.
+
+# naijR 0.4.1
+* Enable the exclusion of selected States from a choropleth map (#27).
+* Cleaner output for `states` and `lgas` objects.
+
 # naijR 0.4.0
 * Introduce the ability to 'manually' fix names of States or LGAs.
 * Update the documentation with a new vignette.

R/map_nigeria.R

@@ -326,10 +326,14 @@ map_ng <- function(region = character(),
 #' @import mapdata
 .getMapData.default <- function(x) 
 {
+  if (is.factor(x))
+    x <- as.character(x)
+  stopifnot(is.character(x))
   if (identical(x, 'Nigeria'))
     return("mapdata::worldHires")
-  if (x %in% .synonymRegions() || is_state(x))
-    return(.getMapData(states()))
+  if ((length(x) == 1L && (x %in% .synonymRegions()))
+      || all(is_state(x)))
+    return(.getMapData(states(x)))
   .getMapData(lgas(x))
 }
 
@@ -523,6 +527,8 @@ map_ng <- function(region = character(),
     df$ind <- as.integer(df$cat)
     df$color <- colrange[df$ind]
     mapregions <- .getUniqueStateNames(map)
+    if (nrow(df) < length(mapregions))
+      mapregions <- mapregions[mapregions %in% df$region]
     new.ind <- order(df$region, mapregions)
     ord.df <- df[new.ind, ]    # This is why a data frame was made
     colors <- .reassignColours(map$names, ord.df$region, ord.df$color, ...)
@@ -667,10 +673,15 @@ map_ng <- function(region = character(),
 # Reassigns colours to polygons that refer to similar regions i.e. duplicated
 # polygon, ensuring that when the choropleth is drawn, the colours are 
 # properly applied to the respective regions and not recycled.
+#' @importFrom grDevices colours
 .reassignColours <- 
   function(names, all.regions, in.colours, excl.region = NULL, excl.col = NULL)
 {
-  stopifnot(is.character(names), all(is_state(all.regions)), .isHexColor(in.colours))
+  stopifnot({
+    is.character(names)
+    all(is_state(all.regions))
+    .isHexColor(in.colours)
+  })
   out.colours <- new.names <- rep(NA, length(names))
   for (i in seq_along(all.regions)) {
     regx <- .regexDuplicatedPolygons(all.regions[i])
@@ -683,8 +694,15 @@ map_ng <- function(region = character(),
   ## the choropleth and should be given an 'off-colour'
   if (!is.null(excl.region)) {
       off.color <- "grey"
-    if (!is.null(excl.col))
+    if (!is.null(excl.col)) {
+      if (length(excl.col) > 1L)
+        stop("Non-null 'exclude.fill' must be of length 1L")
+      if (!is.character(excl.col))
+        stop("'exclude.fill' must be a string")
+      if (!excl.col %in% colours())
+        stop("'exclude.fill' must be a valid colour")
       off.color <- excl.col
+    }
     excluded <- match(excl.region, new.names)
     out.colours[excluded] <- off.color
   }

tests/testthat/test-map_nigeria.R

@@ -510,6 +510,48 @@ test_that("Choropleth map can be formed with excluded regions", {
     ),
     mapClass
   )
+  
+  expect_error(
+    map_ng(
+      data = d,
+      x = total,
+      col = colpal,
+      excluded = excluded.reg,
+      exclude.fill = c(green, "grey"),
+      leg.title = "Legend title",
+      plot = FALSE
+    ),
+    "Non-null 'exclude.fill' must be of length 1L",
+    fixed = TRUE
+  )
+  
+  expect_error(
+    map_ng(
+      data = d,
+      x = total,
+      col = colpal,
+      excluded = excluded.reg,
+      exclude.fill = "notacolour",
+      leg.title = "Legend title",
+      plot = FALSE
+    ),
+    "'exclude.fill' must be a valid colour",
+    fixed = TRUE
+  )
+  
+  expect_error(
+    map_ng(
+      data = d,
+      x = total,
+      col = colpal,
+      excluded = excluded.reg,
+      exclude.fill = 99L,
+      leg.title = "Legend title",
+      plot = FALSE
+    ),
+    "'exclude.fill' must be a string",
+    fixed = TRUE
+  )
 })
 
 
@@ -519,3 +561,29 @@ test_that("Choropleth map can be formed with excluded regions", {
 #   expect_error(map_ng(lgas(c("Imo", "Abia"))), 
 #                "LGA-level maps for adjoining States are not yet supported")
 # })
+
+
+
+test_that(
+  "Mapping fails when choropleth is plotted with repetitive State levels",
+  {
+    data("esoph")
+    set.seed(87)
+    ng.esoph <-  
+      transform(esoph, state = sample(states(), nrow(esoph), TRUE))
+    
+    expect_error(map_ng(data = ng.esoph, x = agegp, plot = FALSE), 
+                 "argument lengths differ")
+    
+    # One record per State (although there are missing states)
+    ng.esoph <- ng.esoph[!duplicated(ng.esoph$state), ]
+    
+    expect_s3_class(
+      map_ng(ng.esoph$state, x = ng.esoph$agegp, plot = FALSE),
+      "map"
+    )
+    expect_s3_class(
+      map_ng(data = ng.esoph, x = agegp, plot = FALSE),
+      "map"
+    ) 
+  })