1) Update and rebuild documentation.

2) Update tests for 2024.
3) Update MAX_YEAR to 2024

Author: tor-gu

DESCRIPTION

@@ -17,7 +17,7 @@ Imports:
     magrittr,
     purrr,
     stringr
-RoxygenNote: 7.2.1
+RoxygenNote: 7.3.2
 Suggests: 
     testthat (>= 3.0.0),
     tibble

R/get_municipalities.R

@@ -1,5 +1,5 @@
 MIN_YEAR <- 2000
-MAX_YEAR <- 2022
+MAX_YEAR <- 2024
 YEARS <- MIN_YEAR:MAX_YEAR
 
 #' Internal function get_municipalities_
@@ -43,7 +43,7 @@ get_municipalities_ <- function(year = MAX_YEAR, geoid_reference_year = year) {
 #' `geoid_ref_as_ref_column` is `TRUE`, in which case the reference
 #' year GEOID will be put in a separate column called `GEOID_ref`.
 #'
-#' @param year The year, from 2000 to 2022. The default is 2022.
+#' @param year The year, from 2000 to 2024. The default is 2024.
 #' @param geoid_year The year to use for GEOIDs
 #' @param geoid_ref_as_ref_column If TRUE, add a separate column for the reference GEOID
 #' @return A table with `GEOID`, `county` and `municipality`

README.Rmd

@@ -20,7 +20,7 @@ knitr::opts_chunk$set(
 <!-- badges: end -->
 
 This is a data package for R that contains every county
-and municipality in New Jersey, from 2000 to 2022.
+and municipality in New Jersey, from 2000 to 2024.
 
 ## Installation
 
@@ -31,9 +31,9 @@ You can install the development version of njmunicipalities from [GitHub](https:
 devtools::install_github("tor-gu/njmunicipalities")
 ```
 
-## Changes in NJ municipalites, 2000-2022
+## Changes in NJ municipalites, 2000-2024
 
-Over the period 2000-2022, there have been several changes to
+Over the period 2000-2024, there have been several changes to
 the list of municipalities in New Jersey:
 
 * In 2005, South Belmar became Lake Como. The US Census assigned
@@ -46,19 +46,19 @@ a new GEOID to Lake Como.
 * In 2022, Pine Valley was absorbed by Pine Hill.
 
 This package will return municipality tables for any year from 2000 to
-2022, and provides tools for dealing the changes from year to year.
+2024, and provides tools for dealing the changes from year to year.
 
 ## Examples
 #### Get a table of municipalities
 Function `get_municipalities` returns a table of municipalities for a
-given year. The default is year 2022.
+given year. The default is year 2024.
 ```{r}
 library(njmunicipalities)
 
-# Municipality table for 2022
+# Municipality table for 2024
 get_municipalities() |> head(n=5)
 ```
-If the year is specified (from 2000 to 2022), the table will reflect the names and US Census GEOIDs in effect for that year. Here is the list for 2007.
+If the year is specified (from 2000 to 2024), the table will reflect the names and US Census GEOIDs in effect for that year. Here is the list for 2007.
 ```{r}
 # Municipality list for 2007
 get_municipalities(2007) |> head(n=5)

README.md

@@ -9,7 +9,7 @@
 <!-- badges: end -->
 
 This is a data package for R that contains every county and municipality
-in New Jersey, from 2000 to 2022.
+in New Jersey, from 2000 to 2024.
 
 ## Installation
 
@@ -21,41 +21,41 @@ You can install the development version of njmunicipalities from
 devtools::install_github("tor-gu/njmunicipalities")
 ```
 
-## Changes in NJ municipalites, 2000-2022
+## Changes in NJ municipalites, 2000-2024
 
-Over the period 2000-2022, there have been several changes to the list
+Over the period 2000-2024, there have been several changes to the list
 of municipalities in New Jersey:
 
--   In 2005, South Belmar became Lake Como. The US Census assigned a new
-    GEOID to Lake Como.
--   In 2007, Dover township in Ocean County became Toms River and was
-    assigned a new GEOID.
--   In 2008, Washington township in Mercer County became Robbinsville
-    township and was assigned a new GEOID.
--   In 2009, West Paterson became Woodland Park, and was assigned a new
-    GEOID.
--   In 2010, Caldwell borough was assigned a new GEOID from the the US
-    Census, though there was no name change at this time.
--   In 2013, Princeton borough and Princeton township merged. The merged
-    municipality retained the Princeton borough GEOID, though the US
-    Census started using the name ‘Princeton’ in place of ‘Princeton
-    borough’ for the merged municipality.
--   In 2022, Pine Valley was absorbed by Pine Hill.
+- In 2005, South Belmar became Lake Como. The US Census assigned a new
+  GEOID to Lake Como.
+- In 2007, Dover township in Ocean County became Toms River and was
+  assigned a new GEOID.
+- In 2008, Washington township in Mercer County became Robbinsville
+  township and was assigned a new GEOID.
+- In 2009, West Paterson became Woodland Park, and was assigned a new
+  GEOID.
+- In 2010, Caldwell borough was assigned a new GEOID from the the US
+  Census, though there was no name change at this time.
+- In 2013, Princeton borough and Princeton township merged. The merged
+  municipality retained the Princeton borough GEOID, though the US
+  Census started using the name ‘Princeton’ in place of ‘Princeton
+  borough’ for the merged municipality.
+- In 2022, Pine Valley was absorbed by Pine Hill.
 
 This package will return municipality tables for any year from 2000 to
-2022, and provides tools for dealing the changes from year to year.
+2024, and provides tools for dealing the changes from year to year.
 
 ## Examples
 
 #### Get a table of municipalities
 
 Function `get_municipalities` returns a table of municipalities for a
-given year. The default is year 2022.
+given year. The default is year 2024.
 
 ``` r
 library(njmunicipalities)
 
-# Municipality table for 2022
+# Municipality table for 2024
 get_municipalities() |> head(n=5)
 #> # A tibble: 5 × 3
 #>   GEOID      county          municipality        
@@ -67,7 +67,7 @@ get_municipalities() |> head(n=5)
 #> 5 3400108710 Atlantic County Buena Vista township
 ```
 
-If the year is specified (from 2000 to 2022), the table will reflect the
+If the year is specified (from 2000 to 2024), the table will reflect the
 names and US Census GEOIDs in effect for that year. Here is the list for
 2007.
 
@@ -135,7 +135,7 @@ dplyr::anti_join(
   get_municipalities(2005),
   get_municipalities(2004)
 )
-#> Joining, by = c("GEOID", "county", "municipality")
+#> Joining with `by = join_by(GEOID, county, municipality)`
 #> # A tibble: 1 × 3
 #>   GEOID      county          municipality     
 #>   <chr>      <chr>           <chr>            
@@ -154,7 +154,7 @@ get_municipalities(2005,
   dplyr::left_join(get_municipalities(2004), 
                    by = c("GEOID_ref" = "GEOID", "county"),
                    suffix = c("", "_ref"))
-#> Joining, by = c("GEOID", "county", "municipality")
+#> Joining with `by = join_by(GEOID, county, municipality)`
 #> # A tibble: 1 × 5
 #>   GEOID_ref  GEOID      county          municipality      municipality_ref    
 #>   <chr>      <chr>      <chr>           <chr>             <chr>               

man/get_municipalities.Rd

@@ -1,11 +1,11 @@
 test_that("get_municipalities handles bad year", {
   expect_error(get_municipalities(1999))
-  expect_error(get_municipalities(2023))
+  expect_error(get_municipalities(2025))
 })
 
 test_that("get_municipalities handles bad reference year", {
   expect_error(get_municipalities(2010, 1999))
-  expect_error(get_municipalities(2010, 2023))
+  expect_error(get_municipalities(2010, 2025))
 })
 
 
@@ -145,12 +145,12 @@ test_that("get_municipalities handles geoid_ref_as_ref_column", {
 
 test_that("get_geoid_cross_references handles bad years", {
   expect_error(get_geoid_cross_references(2000, 1999:2021))
-  expect_error(get_geoid_cross_references(2000, 2000:2023))
+  expect_error(get_geoid_cross_references(2000, 2000:2025))
 })
 
 test_that("get_geoid_cross_references handles bad reference year", {
   expect_error(get_geoid_cross_references(1999, 2010))
-  expect_error(get_geoid_cross_references(2023, 2010))
+  expect_error(get_geoid_cross_references(2025, 2010))
 })