Merge pull request #51 from ropensci/v0.5.0

air format, added new maintainer, updated data, vignettes to 2024 except states

Author: jacciz

.Rbuildignore

@@ -14,3 +14,7 @@
 ^Makefile$
 ^\.github$
 ^CRAN-RELEASE$
+^[.]?air[.]toml$
+^codemeta.json$
+^doc$
+^Meta$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to USAboundaries
+
+This outlines how to propose a change to USAboundaries.
+For a detailed discussion on contributing to this and other tidyverse packages, please see the [development contributing guide](https://rstd.io/tidy-contrib) and our [code review principles](https://code-review.tidyverse.org/).
+
+## Fixing typos
+
+You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file. 
+This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file. 
+You can find the `.R` file that generates the `.Rd` by reading the comment in the first line.
+
+## Bigger changes
+
+If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. 
+If you’ve found a bug, please file an issue that illustrates the bug with a minimal 
+[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed).
+See our guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice.
+
+### Pull request process
+
+*   Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("ropensci/USAboundaries", fork = TRUE)`.
+
+*   Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. 
+    If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. 
+*   Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`.
+
+*   Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
+    The title of your PR should briefly describe the change.
+    The body of your PR should contain `Fixes #issue-number`.
+
+*  For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in <https://style.tidyverse.org/news.html>.
+
+### Code style
+
+*   New code should follow the tidyverse [style guide](https://style.tidyverse.org). 
+    You can use [Air](https://posit-dev.github.io/air/) to apply this style, but please don't restyle code that has nothing to do with your PR.  
+
+*  We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation.  
+
+*  We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. 
+   Contributions with test cases included are easier to accept.  
+
+## Code of Conduct
+
+Please note that the USAboundaries project is released with a [Contributor
+Code of Conduct](https://ropensci.org/code-of-conduct/). 
+By
+contributing to this project, you agree to abide by its terms.

.github/workflows/R-CMD-check.yaml

@@ -1,12 +1,13 @@
-# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
     branches: [main, master]
   pull_request:
-    branches: [main, master]
 
-name: R-CMD-check
+name: R-CMD-check.yaml
+
+permissions: read-all
 
 jobs:
   R-CMD-check:
@@ -18,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          - {os: macOS-latest,   r: 'release'}
+          - {os: macos-latest,   r: 'release'}
           - {os: windows-latest, r: 'release'}
           - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
           - {os: ubuntu-latest,   r: 'release'}
@@ -29,31 +30,22 @@ jobs:
       R_KEEP_PKG_SOURCE: yes
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: r-lib/actions/setup-pandoc@v2
 
-      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
           http-user-agent: ${{ matrix.config.http-user-agent }}
           use-public-rspm: true
-          extra-repositories: https://ropensci.r-universe.dev
 
-      - uses: r-lib/actions/setup-r-dependencies@v1
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: rcmdcheck
-
-      - uses: r-lib/actions/check-r-package@v1
-
-      - name: Show testthat output
-        if: always()
-        run: find check -name 'testthat.Rout*' -exec cat '{}' \; || true
-        shell: bash
+          extra-packages: any::rcmdcheck
+          needs: check
 
-      - name: Upload check results
-        if: failure()
-        uses: actions/upload-artifact@main
+      - uses: r-lib/actions/check-r-package@v2
         with:
-          name: ${{ runner.os }}-r${{ matrix.config.r }}-results
-          path: check
+          upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

.github/workflows/format-suggest.yaml

@@ -0,0 +1,46 @@
+# Workflow derived from https://github.com/posit-dev/setup-air/tree/main/examples
+
+on:
+  # Using `pull_request_target` over `pull_request` for elevated `GITHUB_TOKEN`
+  # privileges, otherwise we can't set `pull-requests: write` when the pull
+  # request comes from a fork, which is our main use case (external contributors).
+  #
+  # `pull_request_target` runs in the context of the target branch (`main`, usually),
+  # rather than in the context of the pull request like `pull_request` does. Due
+  # to this, we must explicitly checkout `ref: ${{ github.event.pull_request.head.sha }}`.
+  # This is typically frowned upon by GitHub, as it exposes you to potentially running
+  # untrusted code in a context where you have elevated privileges, but they explicitly
+  # call out the use case of reformatting and committing back / commenting on the PR
+  # as a situation that should be safe (because we aren't actually running the untrusted
+  # code, we are just treating it as passive data).
+  # https://securitylab.github.com/resources/github-actions-preventing-pwn-requests/
+  pull_request_target:
+
+name: format-suggest.yaml
+
+jobs:
+  format-suggest:
+    name: format-suggest
+    runs-on: ubuntu-latest
+
+    permissions:
+      # Required to push suggestion comments to the PR
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Install
+        uses: posit-dev/setup-air@v1
+
+      - name: Format
+        run: air format .
+
+      - name: Suggest
+        uses: reviewdog/action-suggester@v1
+        with:
+          level: error
+          fail_level: error
+          tool_name: air

.github/workflows/test-coverage.yaml

@@ -0,0 +1,62 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+name: test-coverage.yaml
+
+permissions: read-all
+
+jobs:
+  test-coverage:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::covr, any::xml2
+          needs: coverage
+
+      - name: Test coverage
+        run: |
+          cov <- covr::package_coverage(
+            quiet = FALSE,
+            clean = FALSE,
+            install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
+          )
+          print(cov)
+          covr::to_cobertura(cov)
+        shell: Rscript {0}
+
+      - uses: codecov/codecov-action@v5
+        with:
+          # Fail if error if not on PR, or if on PR and token is given
+          fail_ci_if_error: ${{ github.event_name != 'pull_request' || secrets.CODECOV_TOKEN }}
+          files: ./cobertura.xml
+          plugins: noop
+          disable_search: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Show testthat output
+        if: always()
+        run: |
+          ## --------------------------------------------------------------------
+          find '${{ runner.temp }}/package' -name 'testthat.Rout*' -exec cat '{}' \; || true
+        shell: bash
+
+      - name: Upload test results
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-test-failures
+          path: ${{ runner.temp }}/package

.gitignore

@@ -0,0 +1,7 @@
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+inst/doc
+/doc/
+/Meta/

DESCRIPTION

@@ -1,16 +1,17 @@
 Package: USAboundaries
 Type: Package
 Title: Historical and Contemporary Boundaries of the United States of America
-Version: 0.4.0
+Version: 0.5.0
 Authors@R: c(person("Lincoln", "Mullen",
     email = "lincoln@lincolnmullen.com",
-    role = c("aut", "cre"),
+    role = c("aut"),
     comment = c(ORCID = "0000-0001-5103-6917")),
     person("Jordan", "Bratt",
     email = "jfbratt@gmail.com",
     role = c("aut"),
     comment = c(ORCID = "0000-0001-9051-7203")),
-    person("United States Census Bureau", role = "cph"))
+    person("United States Census Bureau", role = "cph"),
+    person("Jacci", "Ziebert", email = "jacciziebert@gmail.com", role = "cre"))
 Description: The boundaries for geographical units in the United States of
     America contained in this package include state, county, congressional
     district, and zip code tabulation area. Contemporary boundaries are provided
@@ -20,21 +21,26 @@ Description: The boundaries for geographical units in the United States of
     provided in the 'USAboundariesData' package; this package provides an
     interface to access that data.
 License: MIT + file LICENSE
-URL: http://lincolnmullen.com/software/usaboundaries/, https://github.com/ropensci/USAboundaries
+URL: https://docs.ropensci.org/USAboundaries, https://github.com/ropensci/USAboundaries
 BugReports: https://github.com/ropensci/USAboundaries/issues
 Depends:
-    R (>= 3.1.1)
+    R (>= 3.5)
+Imports:
+    USAboundariesData (>= 0.4.0)
+Remotes:
+    ropensci/USAboundariesData
 Suggests:
-    sf (>= 1.0.0),
-    testthat (>= 0.9.1),
-    USAboundariesData (>= 0.4.0),
     covr,
+    dplyr,
     knitr,
+    leaflet,
     rmarkdown,
-    dplyr,
-    leaflet
-RoxygenNote: 7.1.2
-Additional_repositories: https://ropensci.r-universe.dev
+    sf (>= 1.0.0),
+    testthat (>= 0.9.1),
+    tibble
+RoxygenNote: 7.3.3
+Additional_repositories:
+    https://ropensci.r-universe.dev
 LazyData: true
 LazyDataCompression: xz
 VignetteBuilder: knitr

NEWS.md

@@ -1,10 +1,5 @@
-# USAboundaries 0.3.1
-
-- New vignette demonstrating the package's functionality (#40).
-- Additions and clarifications to documentation following @AndySouth's suggestions for JOSS peer review (#38).
-- `us_cities()` now returns an `sf` object rather than a data frame (#36).
-- `us_cities()` gains a `states` argument to match other functions in the package (#35).
-- Citation to JOSS paper.
+# USAboundaries 0.5.0
+- Update Census Bureau data from 2020 to 2024.
 
 # USAboundaries 0.4.0
 
@@ -13,6 +8,14 @@
 - Remove the `us_boundaries()` function was a needless wrapper around other functions.
 - Prompt user to install data package rather than installing it for them.
 
+# USAboundaries 0.3.1
+
+- New vignette demonstrating the package's functionality (#40).
+- Additions and clarifications to documentation following @AndySouth's suggestions for JOSS peer review (#38).
+- `us_cities()` now returns an `sf` object rather than a data frame (#36).
+- `us_cities()` gains a `states` argument to match other functions in the package (#35).
+- Citation to JOSS paper.
+
 # USAboundaries 0.3.0
 
 - Moved most data to USAboundariesData. This improves loading time and permits more frequent updates to the user-facing package.

R/data-doc.R

@@ -1,10 +1,9 @@
 #' U.S. state boundaries
 #'
 #' The U.S. Census Bureau provides
-#' \href{https://www.census.gov/geographies/mapping-files/time-series/geo/tiger-line-file.html}{cartographic
-#' boundary files} for current U.S. boundaries. This package has only the
-#' low-resolution contemporary state boundaries. Other census boundary files are
-#' provided by and documented in the USAboundariesData package.
+#' \href{https://www.census.gov/geographies/mapping-files/time-series/geo/tiger-line-file.html}{cartographic boundary files} for current U.S. boundaries. This package has
+#' only the low-resolution contemporary state boundaries. Other census boundary
+#' files are provided by and documented in the USAboundariesData package.
 #' @seealso For citations for the other Census boundary files provided by the
 #'   USAboundariesData package, see the \code{census_boundaries} documentation
 #'   in that package.