Skip to content

Commit

Permalink
clarify new vintage arg in get_estimates
Browse files Browse the repository at this point in the history
  • Loading branch information
walkerke committed Mar 20, 2024
1 parent 85f3c5d commit aab2900
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Expand Up @@ -6,7 +6,7 @@ Authors@R: c(
person(given = "Kyle", family = "Walker", email="kyle@walker-data.com", role=c("aut", "cre")),
person(given = "Matt", family = "Herman", email = "mfherman@gmail.com", role = "aut"),
person(given = "Kris", family = "Eberwein", email = "eberwein@knights.ucf.edu", role = "ctb"))
Date: 2024-03-18
Date: 2024-03-20
URL: https://walker-data.com/tidycensus/
BugReports: https://github.com/walkerke/tidycensus/issues
Description: An integrated R interface to several United States Census Bureau
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
@@ -1,6 +1,6 @@
# tidycensus 1.6.3

* Support added in `get_estimates()` for the 2023 PEP datasets. A new argument, `vintage`, allows users to request data by vintage and then by `year` within that vintage.
* Support added in `get_estimates()` for the 2023 PEP datasets. A new argument, `vintage`, allows users to request data by vintage and then by `year` within that vintage for post-2020 PEP datasets.

# tidycensus 1.6

Expand Down
2 changes: 1 addition & 1 deletion R/estimates.R
Expand Up @@ -72,7 +72,7 @@ get_estimates <- function(geography = c("us", "region", "division", "state", "co
shift_geo = FALSE, key = NULL, show_call = FALSE, ...) {

if (missing(vintage) && year > 2020) {
rlang::warn(c("`get_estimates()` now uses the `vintage` argument to specify the PEP vintage, and the `year` argument to isolate a year within that vintage.",
rlang::warn(c("For post-2020 Census estimates, `get_estimates()` now uses the `vintage` argument to specify the PEP vintage, and the `year` argument to isolate a year within that vintage.",
"!" = "This may be a breaking change in your code",
"!" = "Omitting `vintage` may lead to incorrect or unexpected results."))
}
Expand Down

0 comments on commit aab2900

Please sign in to comment.