NEWS.md
read_watersurfaces_hab() has gained an argument
collapse, which is TRUE by default (#203). It
reduces the watersurfaces_types element of the list output
to unique combinations of polygon_id and type,
hereby collapsing the code_orig and certain
columns as needed.
collapse = FALSE.watersurfaces_hab are expected to
implement this in the data source itself, but with
interpreted = TRUE further collapsing by the function
remains necessary to maintain uniqueness by polygon_id and
type.read_favenv() to return favourable
environmental ranges of types (#195).expand_types() gains an argument mark
(#198). If set as TRUE, the logical columns
has_been_expanded and added_by_expansion are
added. These mark rows as origin or destination of type expansion,
respectively.convert_line_endings() to maintain text
file integrity (checksums) across platforms (#208). See its
documentation for advice on line endings management in combination with
a distributed version control system like Git, or with text file
generating functions such as git2rdata::write_vc().The following interim data source versions are now supported by the corresponding functions (#200):
habitatmap_stdized_2024_v99_interim
(read_habitatmap_stdized())habitatmap_terr_2024_v99_interim
(read_habitatmap_terr())watersurfaces_hab_v6.1_interim
(read_watersurfaces_hab())Function documentation was updated accordingly. Interim versions are
added only at the end of the version argument of the read
functions, since they do not receive the same level of quality control.
Please note that it is advised to use a regular version of these data
sources instead.
The following new data source versions are now supported by the corresponding functions (#192):
watersurfaces_2024
(read_watersurfaces())watersurfaces_hab_v6
(read_watersurfaces_hab())The following new data source versions are now supported by the corresponding functions (#184):
habitatmap_2023 (read_habitatmap())habitatmap_stdized_2023_v1
(read_habitatmap_stdized())habitatmap_terr_2023_v1
(read_habitatmap_terr())habitatstreams_2023
(read_habitatstreams())watersurfaces_hab_v5
(read_watersurfaces_hab())Function documentation was updated accordingly.
rbbvos+ from built-in data sourcesrbbvos+ has been considered too loosely defined,
as an intermediate between rbbvos and
6510_hua, and it has not been mapped consistently. Hence
this type is considered obsolete and it has been dropped from the
types and namelist data sources (#182).
However do note that it exists in versions of habitatmap
and derived data sources.expand_types() has been adjusted accordingly
(#182).Including:
fix_geom implementation in
read_watersurfaces() is now more efficient (#185);read_habitatmap() also gained a fix_geom
argument (#184);read_habitatsprings() now returns integer IDs as
integers (#180);expand_types() with a grouped data frame is now more
efficient (13d05ec);read_GRTSmh(), read_GRTSmh_base4frac(),
read_GRTSmh_diffres() and read_raster_runif()
now return a SpatRaster object from {terra} by default (#173).
Previous behaviour using {raster} can still be restored; see below.
However do note that {raster} is a legacy package and {terra} is its
successor.
The package can be configured using options() or
corresponding environment variables. Current configuration state is
returned by n2khab_options(). See
?n2khab_options for information on package
configuration.
Two settings are now available:
read_schemes() and read_scheme_types() were
moved to a new package {n2khabmon}. In {n2khab} they
are still functional but deprecated, and will eventually disappear
(#175). The accompanying data sources schemes and
scheme_types have moved to {n2khabmon}. {n2khab} 0.10.0
will be the minimum version required by {n2khabmon}.
download_zenodo() has been improved (#169):
read_watersurfaces() gained extra capabilities (#168):
watersurfaces_v1.2 is now
supported;fix_geom argument allows to fix invalid or
corrupt geometries on the fly. This behaviour is turned off by default
(see #60).namelist has been updated with improved
type names (#163; thanks @jeroenvdborre).read_habitatmap() and derived functions (#165).master is replaced by
main (#164).types and env_pressures data sources. Since it
is expected that this upgrade is not compatible with older {git2rdata}
versions, the version dependency for {git2rdata} has been updated
(#161).scheme_types data source: update typegroup membership
of type 7210 in scheme GW_03.3 (#161).read_shallowgroundwater() to return the
shallowgroundwater data source (#156).
shallowgroundwater represents the
areas in the Flemish region of Belgium where the mean lowest groundwater
level is estimated to be less than approximately 2 m below soil surface
(inbo/n2khab-preprocessing/pull/61;
https://doi.org/10.5281/zenodo.5902880).types, schemes,
scheme_types, namelist were updated (#150,
#151, #154, #158):
groundw_dep for type
91F0;ep_07.2 and
ep_07.4 received updated (Dutch) explanations;HQ2190 has been replaced by two schemes
HQ2190_terr and HQ2190_aq;GW_05.1_aq (with
contributions from L. Denys & A. Leyssen).The following new data source versions are now supported by their associated reading functions:
habitatmap_2020 (read_habitatmap() -
#139)habitatmap_stdized_2020_v1
(read_habitatmap_stdized() - #139, #140)habitatmap_terr_2020_v1
(read_habitatmap_terr() - #139, #140)habitatstreams_v1.7 (read_habitatstreams()
- #114)watersurfaces_v1.1 (read_watersurfaces() -
#118)watersurfaces_hab_v4
(read_watersurfaces_hab() - #142)Function documentation was updated accordingly and refined.
read_raster_runif() to return the
raster_runif data source (#136, #138)
raster_runif is a raster with cells
matching those of GRTSmaster_habitats. Their values are
uniformly distributed random numbers between 0 and 1 (inbo/n2khab-preprocessing/pull/55
and following pull requests; https://doi.org/10.5281/zenodo.4745983).checksum() and associated shortcut functions
to calculate file checksums (#122)Including:
scheme_types data source: updates in typegroup
memberships of MNE scheme GW_05.1_terr (#116)expand_types() now also supports expanding
5130_hei to 5130 (#143)read_watercourse_100mseg() (#105) to return
the watercourse_100mseg data source or one of its elements.
watercourse_100mseg is a new processed data source (inbo/n2khab-preprocessing/pull/44;
https://doi.org/10.5281/zenodo.4452577).read_watersurfaces() has been limited explicitly to
using data source version ‘watersurfaces_v1.0’. Accommodation of the
newer ‘watersurfaces_v1.1’ is planned for later.path argument (#92).
Existing R code will continue to run normally if you complied with the
recommended file organization (see
vignette("v020_datastorage") and
vignette("v022_example")) and did not set the
path and file arguments.read_habitatquarries() for reading the
habitatquarries data source (#83, #94, inbo/n2khab-preprocessing/pull/41).schemes & scheme_types: updates of
spatial restrictions, names and typegroup names of MNE schemes (for
defining the schemes’ target populations);types: update groundwater dependency of type
2170.download_zenodo() (from {inborutils})
(#89)types: updates of flood dependency scores and
hydrological class of several types, following several expert
discussions and checksschemes & scheme_types: updates
regarding spatial restrictions, types and typegroup memberships of MNE
schemes (for defining the schemes’ target populations); added MHQ scheme
‘HQ2120’env_pressures: updated explanations. Each pressure now
has its own explanationnamelist: according updatesrenv
framework implemented to enhance reproducibility of generating the
built-in textual data sources (#72)read_env_pressures(): an extra column
‘remarks’ is now returned (#65)read_soilmap() for reading the
soilmap or processed soilmap_simple data
sources (#29; inbo/n2khab-preprocessing/pull/34)read_soilmap() as an example target (#29)read_habitatsprings() accommodates the latest version
of the habitatsprings data source (#62, 5604002)read_habitatsprings() optionally aggregates points to
(population) units (#70)read_habitatmap_terr() now drops occurrences of type
7220 by default, given the information returned by
read_habitatsprings() (#71)Further, a number of smaller fixes and enhancements were made.
read_GRTSmh(), read_GRTSmh_base4frac(),
read_GRTSmh_diffres(): avoided CRS error with more recent
GDAL/PROJ.4 installations (#61)read_habitatmap_terr(): fixed non-functioning argument
keep_aq_types=FALSE (#60)types and
env_pressures)download_zenodo() from {inborutils}pkgdown
This package is the successor of the {n2khabutils} package. Previous
to commit c8608d9, the code was part of the n2khab-monitoring
repo (formerly ‘n2khab-inputs’), where the original version history
remains stored. At that time, the package was called {n2khabutils}. As a
convenience, the {n2khab} repo still holds the rewritten (shrinked)
package history from before commit c8608d9, as defined by
the related files and folders. See this
issue in the ‘n2khab-monitoring’ repo, where the migration is
documented.