Refactor map creation functions (#17)

* Created `alaska_bbox()`, `hawaii_bbox()`, `alaska_transform()`, and
`hawaii_transform()` internal functions.
* These are intended to be used by `usmap::usmap_transform()` for
consistency.
* Removed `as_sf` deprecation warnings since this change is intended to
be an implementation detail from the perspective of `usmap`.
* i.e. warnings should not be seen by `usmap` users for decisions made
within this package they have little control over

Author: pdil

R/create-us-map.R

@@ -5,13 +5,24 @@
 #' `create_us_map()` creates the modified shapefiles used by the
 #' \link[usmap]{usmap} package.
 #'
+#' `ea_crs()` returns the US National Atlas Equal Area coordinate reference system
+#' (CRS) used by this package and `usmap`.
+#'
 #' `transform2D()` computes a two dimensional affine transformation matrix
 #' for the provided rotation angle and scale factor.
 #'
+#' `transform_alaska()` applies the appropriate transform for the Alaska polygons.
+#'
+#' `transform_hawaii()` applies the appropriate transform for the Hawaii polygons.
+#'
 #' `compute_centroids()` computes the modified centroids for each state or
 #' county polygon using a center-of-mass technique on the largest polygon in
 #' the region.
 #'
+#' `alaska_bbox()` returns the bounding box of Alaska pre-transformation.
+#'
+#' `hawaii_bbox()` returns the bounding box of Hawaii pre-transformation.
+#'
 #' @note
 #' Using these functions externally is not recommended since they make certain
 #' undocumented assumptions that may not work with all inputs.
@@ -51,20 +62,13 @@ create_us_map <- function(
   us <- sf::read_sf(input_file)
 
   # ea: US National Atlas Equal Area
-  ea_crs <- sf::st_crs(9311)
-  us_ea <- sf::st_transform(us, ea_crs)
+  us_ea <- sf::st_transform(us, ea_crs())
 
   # FIPS code for Alaska = 02
-  alaska <- us_ea[us_ea$STATEFP == "02", ]
-  sf::st_geometry(alaska) <- sf::st_geometry(alaska) * transform2D(-50, 1 / 2)
-  sf::st_geometry(alaska) <- sf::st_geometry(alaska) + c(3e5, -2e6)
-  sf::st_crs(alaska) <- ea_crs
+  alaska <- transform_alaska(us_ea[us_ea$STATEFP == "02", ])
 
   # FIPS code for Hawaii = 15
-  hawaii <- us_ea[us_ea$STATEFP == "15", ]
-  sf::st_geometry(hawaii) <- sf::st_geometry(hawaii) * transform2D(-35)
-  sf::st_geometry(hawaii) <- sf::st_geometry(hawaii) + c(3.6e6, 1.8e6)
-  sf::st_crs(hawaii) <- ea_crs
+  hawaii <- transform_hawaii(us_ea[us_ea$STATEFP == "15", ])
 
   # keep only US states (i.e. remove territories, minor outlying islands, etc.)
   # also remove Alaska (02) and Hawaii (15) so that we can add in shifted one
@@ -116,6 +120,12 @@ create_us_map <- function(
   sf::st_write(centroids, centroids_output_file, quiet = TRUE, append = FALSE)
 }
 
+#' @rdname create_us_map
+#' @keywords internal
+ea_crs <- function() {
+  sf::st_crs(9311)  # US National Atlas Equal Area coordinate reference system
+}
+
 #' @rdname create_us_map
 #' @keywords internal
 transform2D <- function(angle = 0, scale = 1) {
@@ -124,6 +134,26 @@ transform2D <- function(angle = 0, scale = 1) {
            -scale * sin(r), scale * cos(r)), 2, 2)
 }
 
+#' @rdname create_us_map
+#' @keywords internal
+transform_alaska <- function(alaska) {
+  sf::st_geometry(alaska) <- sf::st_geometry(alaska) * transform2D(-50, 1 / 2)
+  sf::st_geometry(alaska) <- sf::st_geometry(alaska) + c(3e5, -2e6)
+  sf::st_crs(alaska) <- ea_crs()
+
+  alaska
+}
+
+#' @rdname create_us_map
+#' @keywords internal
+transform_hawaii <- function(hawaii) {
+  sf::st_geometry(hawaii) <- sf::st_geometry(hawaii) * transform2D(-35)
+  sf::st_geometry(hawaii) <- sf::st_geometry(hawaii) + c(3.6e6, 1.8e6)
+  sf::st_crs(hawaii) <- ea_crs()
+
+  hawaii
+}
+
 #' @rdname create_us_map
 #' @keywords internal
 compute_centroids <- function(polygons, iterations = 3, initial_width_step = 10) {
@@ -195,3 +225,31 @@ compute_centroids <- function(polygons, iterations = 3, initial_width_step = 10)
   sf::st_agr(new_polygons) <- "constant"
   sf::st_centroid(new_polygons)
 }
+
+#' @rdname create_us_map
+#' @keywords internal
+alaska_bbox <- function() {
+  sf::st_bbox(
+    c(
+      xmin = -4377000,
+      xmax = -1519000,
+      ymin = 1466000,
+      ymax = 3914000
+    ),
+    crs = ea_crs()
+  )
+}
+
+#' @rdname create_us_map
+#' @keywords internal
+hawaii_bbox <- function() {
+  sf::st_bbox(
+    c(
+      xmin = -5750000,
+      xmax = -5450000,
+      ymin = -1050000,
+      ymax = -441000
+    ),
+    crs = ea_crs()
+  )
+}

R/fips-data.R

@@ -3,7 +3,7 @@
 #' @param regions The region breakdown for the map, can be one of
 #'   (\code{"states"}, \code{"state"}, \code{"counties"}, \code{"county"}).
 #'   The default is \code{"states"}.
-#' @param as_sf DEPRECATED. This parameter has no effect and will be removed in
+#' @param as_sf Defunct, this parameter no longer has any effect and will be removed in
 #'  the future.
 #'
 #' @return An data frame of FIPS codes of the desired \code{regions}.
@@ -21,10 +21,6 @@ fips_data <- function(
 ) {
   regions <- match.arg(regions)
 
-  if (!missing("as_sf"))
-    warning("`as_sf` is deprecated and no longer has any effect, all data is
-            returned as an `sf` object.")
-
   map_data <- usmapdata::us_map(regions)
   sf::st_geometry(map_data) <- NULL
   map_data

R/us-map.R

@@ -14,7 +14,7 @@
 #'  same name. The regions listed in the \code{include} parameter are applied first and the
 #'  \code{exclude} regions are then removed from the resulting map. Any excluded regions
 #'  not present in the included regions will be ignored.
-#' @param as_sf DEPRECATED. This parameter has no effect and will be removed in
+#' @param as_sf Defunct, this parameter no longer has any effect and will be removed in
 #'  the future.
 #'
 #' @return An `sf` data frame of US map coordinates divided by the desired \code{regions}.
@@ -36,10 +36,6 @@ us_map <- function(
 ) {
   regions <- match.arg(regions)
 
-  if (!missing("as_sf"))
-    warning("`as_sf` is deprecated and no longer has any effect, all data is
-            returned as an `sf` object.")
-
   if (regions == "state") regions <- "states"
   else if (regions == "county") regions <- "counties"
 
@@ -70,7 +66,7 @@ us_map <- function(
 #' @param regions The region breakdown for the map, can be one of
 #'   (\code{"states"}, \code{"counties"}, as specified by the internal file names.
 #'   The default is \code{"states"}.
-#' @param as_sf DEPRECATED. This parameter has no effect and will be removed in
+#' @param as_sf Defunct, this parameter no longer has any effect and will be removed in
 #'  the future.
 #'
 #' @return An `sf` data frame of state or county centroid labels and positions
@@ -83,10 +79,6 @@ centroid_labels <- function(
 ) {
   regions <- match.arg(regions)
 
-  if (!missing("as_sf"))
-    warning("`as_sf` is deprecated and no longer has any effect, all data is
-            returned as an `sf` object.")
-
   sf::read_sf(
     system.file("extdata", paste0("us_", regions, "_centroids.gpkg"),
                 package = "usmapdata")

man/centroid_labels.Rd

@@ -39,7 +39,3 @@ test_that("county FIPS codes load correctly", {
   expect_equal(county_fips[[3144, "county"]], "Weston County")
   expect_equal(county_fips[[3144, "fips"]], "56045")
 })
-
-test_that("as_sf deprecation warning occurs", {
-  expect_warning(fips_data(as_sf = TRUE))
-})

man/create_us_map.Rd

@@ -74,8 +74,3 @@ test_that("centroid labels are loaded", {
   expect_equal(length(centroid_labels("states")[[1]]), 51)
   expect_equal(length(centroid_labels("counties")[[1]]), 3144)
 })
-
-test_that("as_sf deprecation warning occurs", {
-  expect_warning(us_map(as_sf = TRUE))
-  expect_warning(centroid_labels(as_sf = TRUE))
-})