Remove PR excluded by default

Author: pdil

NEWS.md

@@ -3,9 +3,8 @@
 ### New Features
 * Puerto Rico has been added!
   * Finally, after years of procrastinating, Puerto Rico has finally been added to the map, see [Issue #48](https://github.com/pdil/usmapdata/issues/48).
-  * By default, it is not shown. It can be shown by setting `include = "PR"` (or using any combination of `include`/`exclude` parameters that results in `PR` being shown).
-  * The default can be changed to show `PR` by setting the environment variable `USMAP_EXCLUDE_PR = FALSE`.
   * All included map files have been retroactively updated to include Puerto Rico, so any valid value of `data_year` will include Puerto Rico if desired.
+  * `us_map()` and `fips_data()` both return Puerto Rico in their data sets and it can be included or excluded just like any state (using FIPS, full name, abbreviation, etc.).
   * Special thanks [@dcaud](https://github.com/dcaud) who started this work [years ago](https://github.com/pdil/usmap/pull/34).
 
 ### Enhancements

R/aaa.R

@@ -11,18 +11,16 @@
 #' @param exclude The regions to exclude in the resulting map. If `regions` is
 #'  `"states"`/`"state"`, the value can be either a state name, abbreviation or FIPS code.
 #'  For counties, the FIPS must be provided as there can be multiple counties with the
-#'  same name. The regions listed in the `include` parameter are applied first and the
-#'  `exclude` regions are then removed from the resulting map. Any excluded regions
-#'  not present in the included regions will be ignored. The default value is "PR".
-#'  The default can be set to be an empty vector by setting the environment variable
-#'  `USMAP_EXCLUDE_PR = FALSE`.
+#'  same name. The regions listed in the `include` parameter take precedence over
+#'  regions listed in `exclude`. If both parameters include the same region(s) they
+#'  will be included in the map.
 #' @param data_year The year for which to obtain map data.
-#' If the value is `NULL`, the most recent year's data is used. If the
-#' provided year is not found from the available map data sets, the next most
-#' recent year's data is used. This can be used if an older data set is being
-#' plotted on the US map so that the data matches the map more accurately.
-#' Therefore, the provided value should match the year of the plotted data set.
-#' The default is `NULL`, i.e. the most recent available year is used.
+#'  If the value is `NULL`, the most recent year's data is used. If the
+#'  provided year is not found from the available map data sets, the next most
+#'  recent year's data is used. This can be used if an older data set is being
+#'  plotted on the US map so that the data matches the map more accurately.
+#'  Therefore, the provided value should match the year of the plotted data set.
+#'  The default is `NULL`, i.e. the most recent available year is used.
 #'
 #' @return An `sf` data frame of US map coordinates divided by the desired `regions`.
 #'
@@ -40,7 +38,7 @@
 us_map <- function(
   regions = c("states", "state", "counties", "county"),
   include = c(),
-  exclude = .pkg_env$usmap_default_exclude(),
+  exclude = c(),
   data_year = NULL
 ) {
   regions <- match.arg(regions)
@@ -147,11 +145,3 @@ select_map_year <- function(data_year) {
     data_year
   }
 }
-
-#' @keywords internal
-.pkg_env$usmap_default_exclude <- function() {
-  if (Sys.getenv("USMAP_EXCLUDE_PR", unset = TRUE))
-    c("PR")
-  else
-    c()
-}

R/us-map.R

@@ -9,15 +9,15 @@ test_that("state FIPS codes load correctly", {
   expect_identical(state_fips, states_fips)
 
   expect_equal(length(fips), 3)
-  expect_equal(length(fips[[1]]), 51)
+  expect_equal(length(fips[[1]]), 52)
 
   expect_equal(fips[[1, "abbr"]], "AK")
   expect_equal(fips[[1, "fips"]], "02")
   expect_equal(fips[[1, "full"]], "Alaska")
 
-  expect_equal(fips[[51, "abbr"]], "WY")
-  expect_equal(fips[[51, "fips"]], "56")
-  expect_equal(fips[[51, "full"]], "Wyoming")
+  expect_equal(fips[[52, "abbr"]], "WY")
+  expect_equal(fips[[52, "fips"]], "56")
+  expect_equal(fips[[52, "full"]], "Wyoming")
 })
 
 test_that("county FIPS codes load correctly", {
@@ -27,15 +27,15 @@ test_that("county FIPS codes load correctly", {
   expect_identical(county_fips, counties_fips)
 
   expect_equal(length(county_fips), 4)
-  expect_equal(length(county_fips[[1]]), 3144)
+  expect_equal(length(county_fips[[1]]), 3222)
 
   expect_equal(county_fips[[1, "full"]], "Alaska")
   expect_equal(county_fips[[1, "abbr"]], "AK")
   expect_equal(county_fips[[1, "county"]], "Aleutians East Borough")
   expect_equal(county_fips[[1, "fips"]], "02013")
 
-  expect_equal(county_fips[[3144, "full"]], "Wyoming")
-  expect_equal(county_fips[[3144, "abbr"]], "WY")
-  expect_equal(county_fips[[3144, "county"]], "Weston County")
-  expect_equal(county_fips[[3144, "fips"]], "56045")
+  expect_equal(county_fips[[3222, "full"]], "Wyoming")
+  expect_equal(county_fips[[3222, "abbr"]], "WY")
+  expect_equal(county_fips[[3222, "county"]], "Weston County")
+  expect_equal(county_fips[[3222, "fips"]], "56045")
 })

man/dot-pkg_env.Rd

@@ -2,22 +2,8 @@
 states_map <- us_map(regions = "states")
 counties_map <- us_map(regions = "counties")
 
-test_that("default us_map exclude is set", {
-  withr::with_envvar(c("USMAP_EXCLUDE_PR" = NA), {
-    expect_equal(usmapdata:::.pkg_env$usmap_default_exclude(), c("PR"))
-  })
-
-  withr::with_envvar(c("USMAP_EXCLUDE_PR" = FALSE), {
-    expect_equal(usmapdata:::.pkg_env$usmap_default_exclude(), c())
-  })
-
-  withr::with_envvar(c("USMAP_EXCLUDE_PR" = TRUE), {
-    expect_equal(usmapdata:::.pkg_env$usmap_default_exclude(), c("PR"))
-  })
-})
-
 test_that("structure of states df is correct", {
-  expect_equal(length(unique(states_map$fips)), 51)
+  expect_equal(length(unique(states_map$fips)), 52)
 })
 
 test_that("correct states are included", {
@@ -66,7 +52,7 @@ test_that("include takes precedence over exclude", {
 })
 
 test_that("structure of counties df is correct", {
-  expect_equal(length(unique(counties_map$fips)), 3144)
+  expect_equal(length(unique(counties_map$fips)), 3222)
 })
 
 test_that("correct counties are included", {
@@ -97,10 +83,10 @@ test_that("error occurs for invalid region", {
 })
 
 test_that("centroid labels are loaded", {
-  expect_equal(length(centroid_labels("states")[[1]]), 51)
-  expect_equal(length(centroid_labels("counties")[[1]]), 3144)
-  expect_equal(length(centroid_labels("state")[[1]]), 51)
-  expect_equal(length(centroid_labels("county")[[1]]), 3144)
+  expect_equal(length(centroid_labels("states")[[1]]), 52)
+  expect_equal(length(centroid_labels("counties")[[1]]), 3222)
+  expect_equal(length(centroid_labels("state")[[1]]), 52)
+  expect_equal(length(centroid_labels("county")[[1]]), 3222)
   expect_identical(centroid_labels("counties"), centroid_labels("county"))
   expect_identical(centroid_labels("states"), centroid_labels("state"))
 })