Releases: rOpenGov/giscoR
giscoR 1.0.0
This major release introduces a full overhaul of the codebase and test suite.
Requests now use httr2, and GeoPackage (”gpkg”) becomes the preferred
download format when available. Cached files are reorganized into topic-based
subfolders for easier management.
Because of internal changes, existing caches are not compatible with this
release and must be rebuilt.
Database management has also been improved. Instead of relying on the static
?gisco_db dataset, the package now stores the database in the cache. This
cached database is used for all API calls and can be updated via
gisco_get_cached_db(update_cache = TRUE). In practice, this means that when
GISCO publishes a new yearly release, you can access the new updated data simply
by refreshing the cached database without waiting for a new version of
giscoR.
We have transitioned from rappdirs::user_config_dir() to tools::R_user_dir()
for managing your persistent cache directory. If you are a heavy giscoR user
and already have a cache directory in place, you’ll receive a one-time friendly
message informing you about this migration. Consider it a warm welcome to
giscoR 1.0.0 😉.
The package now requires R ≥ 4.1, and dependency updates improve both
performance and maintainability. All functions return tidy objects (tibbles or
sf objects with tibble data).
Dataset subsetting is now performed at read time using GDAL’s query capabilities
(sf::read_sf()), improving performance and reducing file size. The
geojsonsf dependency is no longer required.
Several new functions and arguments have been added, some functions renamed, and
one deprecated. All bundled datasets have been updated to their latest versions.
We recommend reviewing the updated documentation at
https://ropengov.github.io/giscoR/.
Major changes
- Refactor code and test suite for improved stability.
- Switch API requests to httr2.
- Adopt GeoPackage (
”gpkg”) as the preferred download format. - Reorganize cache into topic-based subfolders.
Note: Previous caches must be recreated.
Compatibility and performance
- Require R ≥ 4.1.
- Update dependencies:
- Add: cli, httr2, lifecycle, tibble
- Remove: geojsonsf
- Return tidy objects consistently.
- Perform dataset subsetting at read time using GDAL queries via
sf::read_sf().
New functions
- Metadata and database utilities:
gisco_get_cached_db()gisco_get_metadata()
gisco_get_census()for accessing census grid data.- New separate functions to access unit data (replacing
gisco_get_units()):gisco_get_unit_country()gisco_get_unit_nuts()gisco_get_unit_urban_audit()
- Functions to access the GISCO ID service
APIgisco_id_api_geonames()gisco_id_api_nuts()gisco_id_api_lau()gisco_id_api_country()gisco_id_api_river_basin()gisco_id_api_biogeo_region()gisco_id_api_census_grid()
Renamed functions
We renamed several functions to improve clarity and consistency:
?gisco_addressapi→?gisco_address_apigisco_get_coastallines()→gisco_get_coastal_lines()gisco_get_postalcodes()→gisco_get_postal_codes()
Old names remain available as aliases.
Argument updates
- Add
extargument to control file format (”gpkg”,”shp”,”geojson”). - Update default
yearto the latest release (#105).
Dataset updates
We updated all bundled datasets to their latest versions and added new ones:
- Update
?gisco_dbto the newest data. - Add
?gisco_countries_2024(replacesgisco_countries). - Add
?gisco_nuts_2024(replacesgisco_nuts). - Add
?gisco_coastal_lines(replacedgisco_coastallines).
The datasets
gisco_countries,gisco_nuts, andgisco_coastallinesare no
longer available. Any code that accessed them directly (e.g.,
giscoR::gisco_countries) will now fail.\Please use the updated datasets or, preferably, retrieve them via the
corresponding functions such asgisco_get_countries()with default
parameters.
Deprecations
- Deprecate
gisco_get_units().- Functionality is now available through
gisco_get_metadata()and the
?gisco_get_unitfamily.
- Functionality is now available through
- Deprecate
cacheargument in heavy-download functions (gisco_get_lau(),
gisco_get_communes()). - In
gisco_bulk_download(), renameid_giscoR→id.
Other updates
- Add Eurostat as copyright holder.
- Rewrite the full test suite.
- Review and improve documentation.
- Reorganize pkgdown site.
- Use cli for all messages.
What's Changed
- Bump actions/checkout from 4 to 5 by @dependabot[bot] in #106
- Bump github/codeql-action from 3 to 4 by @dependabot[bot] in #107
- Bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #108
- giscoR v1.0.0 by @dieghernan in #109
- Add GISCO ID service API support by @dieghernan in #111
Full Changelog: v0.6.1...v1.0.0
What's Changed
- Bump actions/checkout from 4 to 5 by @dependabot[bot] in #106
- Bump github/codeql-action from 3 to 4 by @dependabot[bot] in #107
- Bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #108
- giscoR v1.0.0 by @dieghernan in #109
- Add GISCO ID service API support by @dieghernan in #111
Full Changelog: v0.6.1...v1.0.0
giscoR 0.6.1
- Fix an issue when filtering source on
gisco_get_lau().
What's Changed
- Improve codefactor score by @dieghernan in #100
- Bump dieghernan/cran-status-check from 1 to 2 by @dependabot in #101
Full Changelog: v0.6.0...v0.6.1
giscoR 0.6.0
Update with latest data available
gisco_get_education()andgisco_get_healthcare()gains a newyear
argument: years available now are 2020 and 2023 versions of the dataset.gisco_get_nuts()andgisco_get_countries()now can download the 2024
version of the datasets (#93 @hannesaddec).
What's Changed
- Update internal database to get new versions of the dataset (2024) by @dieghernan in #92
Full Changelog: v0.5.1...v0.6.0
giscoR 0.5.1
- Use CRAN DOI: https://doi.org/10.32614/CRAN.package.giscoR.
gisco_get_education(): Fix API entry points.- Review failing examples.
What's Changed
- Adjust some tests and examples by @dieghernan in #90
Full Changelog: v0.5.0...v0.5.1
giscoR 0.5.0
- New functions:
gisco_get_education().- Add access to GISCO Address
API
through new functions. See?gisco_addressapito know more (#84).
- New dependency: jsonlite added to 'Imports'.
- Update
gisco_dbwith the most up-to-date released data. - Default year of some functions updated to the latest available data:
gisco_get_lau()andgisco_get_urban_audit()default year now is
"2021".
- Update urls in documentation.
giscoR 0.4.2
- Update of docs to avoid warnings on CRAN (#81).
- Rebuild datasets.
Full Changelog: v0.4.2...v0.4.2
giscoR 0.4.1
- Improve documentation, stating where the parameters
countryandregion
applies (#50, #75). - Migrate to httr2 instead of httr.
- Removed
tgs00026dataset, useeurostat::get_eurostat("tgs00026")
instead.
What's Changed
- Bump actions/upload-artifact from 3 to 4 by @dependabot in #73
- Bump github/codeql-action from 2 to 3 by @dependabot in #72
- Improve docs by @dieghernan in #76
Full Changelog: v0.4.0...v0.4.1
giscoR 0.4.0
gisco_get_nuts(): Add an additionalgeocolumn (identical toNUTS_ID)
for enhanced compatibility with eurostat package (#62).- Adjust examples for CRAN.
- Add dependency httr.
What's Changed
- Add geo column to output on NUTS by @dieghernan in #64
- Bump actions/checkout from 3 to 4 by @dependabot in #68
- Examples and fix on errors online based in httr by @dieghernan in #70
Full Changelog: v0.3.5...v0.4.0
giscoR 0.3.5
-
Review examples to avoid CRAN errors and notes.
-
New helper function:
gisco_detect_cache_dir(). -
Now the functions fail gracefully with an informative message, instead of an
error, and returnNULL.
What's Changed
- [ImgBot] Optimize images by @imgbot in #58
- Fail gracefully by @dieghernan in #60
Full Changelog: v0.3.4...v0.3.5
giscoR 0.3.4
- Update tests and documentation.
Full Changelog: v0.3.3...v0.3.4