Deprecated and renamed functions in rgeoboundaries

Version 2.0.0 of rgeoboundaries renamed a number of functions to ensure that all exported functions follow an object_verb() naming scheme and to avoid magical defaults.

The following changes were introduced:

geoboundaries() → gb_get() and gb_get_world().
The gb_adm family → the gb_get_adm family.
gb_metadata() → gb_get_metadata().
gb_max_adm_lvl() → gb_get_max_adm_lvl().

These deprecated functions will be removed in a future release.

Usage

geoboundaries(
  country = NULL,
  adm_lvl = "adm0",
  type = "unsimplified",
  release_type = c("gbOpen", "gbHumanitarian", "gbAuthoritative"),
  quiet = TRUE,
  overwrite = FALSE,
  version = deprecated()
)

gb_adm0(
  country = NULL,
  type = "unsimplified",
  release_type = c("gbOpen", "gbHumanitarian", "gbAuthoritative"),
  quiet = TRUE,
  overwrite = FALSE,
  version = deprecated()
)

gb_adm1(
  country = NULL,
  type = "unsimplified",
  release_type = c("gbOpen", "gbHumanitarian", "gbAuthoritative"),
  quiet = TRUE,
  overwrite = FALSE,
  version = deprecated()
)

gb_adm2(
  country = NULL,
  type = "unsimplified",
  release_type = c("gbOpen", "gbHumanitarian", "gbAuthoritative"),
  quiet = TRUE,
  overwrite = FALSE,
  version = deprecated()
)

gb_adm3(
  country = NULL,
  type = "unsimplified",
  release_type = c("gbOpen", "gbHumanitarian", "gbAuthoritative"),
  quiet = TRUE,
  overwrite = FALSE,
  version = deprecated()
)

gb_adm4(
  country = NULL,
  type = "unsimplified",
  release_type = c("gbOpen", "gbHumanitarian", "gbAuthoritative"),
  quiet = TRUE,
  overwrite = FALSE,
  version = deprecated()
)

gb_adm5(
  country = NULL,
  type = "unsimplified",
  release_type = c("gbOpen", "gbHumanitarian", "gbAuthoritative"),
  quiet = TRUE,
  overwrite = FALSE,
  version = deprecated()
)

gb_metadata(
  country = NULL,
  adm_lvl = "all",
  release_type = c("gbOpen", "gbHumanitarian", "gbAuthoritative")
)

gb_max_adm_lvl(
  country = NULL,
  release_type = c("gbOpen", "gbHumanitarian", "gbAuthoritative")
)

Arguments

country

Character vector of country identifiers. This can be "all" (to return data for all countries), a vector of country names, or ISO3 country codes. See also countrycode::countrycode().

adm_lvl

Type of boundary to retrieve. Accepted values are "all" (all available administrative levels) or a specific ADM level. "adm0" corresponds to country boundaries, "adm1" to first-level subnational boundaries, "adm2" to second-level boundaries, and so on. Uppercase variants (e.g. "ADM1") and numeric values (0, 1, 2, 3, 4, 5) are also accepted.

type

Character. One of "simplified" or "unsimplified". Any other value is treated as "unsimplified".

release_type

One of "gbOpen", "gbHumanitarian", or "gbAuthoritative". For most users, "gbOpen" (the default) is recommended, as it is CC-BY 4.0 compliant and suitable for most purposes provided proper attribution is given:

"gbHumanitarian" files are mirrored from UN OCHA and may have more restrictive licensing.
"gbAuthoritative" files are mirrored from UN SALB and cannot be used for commercial purposes, but are verified through in-country processes.

quiet

logical. If TRUE, suppress informational messages.

overwrite

logical. If TRUE, force a fresh download of the source .zip file, even if it is already cached.

version

Deprecated argument.

Value

The call is forwarded to the corresponding replacement function and returns the same output.

References

rOpenSci, Anderson B, Chamberlain S, DeCicco L, Gustavsen J, Krystalli A, Lepore M, Mullen L, Ram K, Ross N, Salmon M, Vidoni M, Riederer E, Sparks A, Hollister J (2024). rOpenSci Packages: Development, Maintenance, and Peer Review. doi:10.5281/zenodo.10797633.

The tidyverse team. The Tidyverse Style Guide, https://style.tidyverse.org/. Accessed 14 Nov. 2025.

Wickham, Hadley. "Tidy Design Principles." Tidyverse.org, 2025, https://design.tidyverse.org/. Accessed 14 Nov. 2025.

Examples

# Show deprecation messages
gb_metadata()
#> Warning: `gb_metadata()` was deprecated in rgeoboundaries 2.0.0.
#> ℹ Please use `gb_get_metadata()` instead.
#> # A tibble: 715 × 32
#>    boundaryID       boundaryName boundaryISO boundaryYearRepresen…¹ boundaryType
#>    <chr>            <chr>        <chr>       <chr>                  <chr>       
#>  1 ABW-ADM0-133965… Aruba        ABW         2021                   ADM0        
#>  2 AFG-ADM0-778584… Afghanistan  AFG         2014                   ADM0        
#>  3 AFG-ADM1-126533… Afghanistan  AFG         2007                   ADM1        
#>  4 AFG-ADM2-176988… Afghanistan  AFG         2014                   ADM2        
#>  5 AGO-ADM0-711927… Angola       AGO         2021                   ADM0        
#>  6 AGO-ADM1-264088… Angola       AGO         2021                   ADM1        
#>  7 AGO-ADM2-914247… Angola       AGO         2006                   ADM2        
#>  8 AGO-ADM3-770603… Angola       AGO         2014                   ADM3        
#>  9 AIA-ADM0-967247… Anguilla     AIA         2021                   ADM0        
#> 10 ALB-ADM0-442218… Albania      ALB         2003                   ADM0        
#> # ℹ 705 more rows
#> # ℹ abbreviated name: ¹boundaryYearRepresented
#> # ℹ 27 more variables: boundaryCanonical <chr>, boundarySource <chr>,
#> #   boundaryLicense <chr>, licenseDetail <chr>, licenseSource <chr>,
#> #   boundarySourceURL <chr>, sourceDataUpdateDate <dttm>, buildDate <date>,
#> #   Continent <chr>, `UNSDG-region` <chr>, `UNSDG-subregion` <chr>,
#> #   worldBankIncomeGroup <chr>, admUnitCount <dbl>, meanVertices <dbl>, …