Skip to content

Conversation

@PietrH
Copy link
Member

@PietrH PietrH commented Oct 2, 2025

UNDER CONSTRUCTION - DO NOT MERGE

See #417 and github.com/inbo/etn/milestones/8

  • Up version number

AI Summary

This pull request introduces significant updates to the etn package, focusing on modernizing its architecture, improving usability, and enhancing compatibility and reproducibility. The package now defaults to connecting via an API (using the etnservice package), deprecates direct database connection management, and streamlines credentials handling. Several dependencies and functions have been updated or removed, and documentation and citation information have been revised to reflect these changes.

Major architectural and usability changes:

  • The package now connects to the ETN database via an API using the etnservice package, with automatic switching to a local database connection if available. The connection argument is deprecated, and users are prompted for credentials if not stored in the environment. The connect_to_etn() function is also deprecated and now issues a warning instead of establishing a connection. [1] [2] [3] [4]
  • Several deprecated functions (get_deployments(), get_detections(), get_projects(), get_receivers(), list_network_project_codes()) have been removed from the package. [1] [2]

Dependency and environment management:

  • The package dependencies have been updated: new imports include arrow, askpass, cachem, cli, etnservice, httr2, lifecycle, memoise, prettyunits, rlang, and utils. Some dependencies (e.g., DBI, odbc, jsonlite, lubridate) have been removed or moved to Suggests. The Remotes field now includes GitHub sources for etnservice and vcr.
  • The GitHub Actions workflow now tests with R 4.1.0 (the minimum supported version) and passes new environment variables for credentials and VCR control.

Documentation and citation updates:

  • The NEWS.md file has been updated to document all major changes, including new connection logic, credential management, deprecations, and new features.
  • The CITATION.cff file has been updated to reflect the new version, update the preferred citation, and revise software references to match the updated dependencies. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

Miscellaneous improvements:

  • A .gitattributes file was added to standardize text handling and ignore diffs in test fixtures.

These changes collectively modernize the etn package, improve user experience, and ensure consistency between API and local database queries.

References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18]

[email protected] and others added 30 commits September 23, 2025 12:15
…ialisation-instead-of-rds

 Add support for  Apache Feather for API object transfer
…always-matches-the-version-deployed-via-opencpu
Use identical, safer. document reasoning
PietrH and others added 28 commits January 29, 2026 10:52
…. Older versions of arrow do not have this built in.
switch to local downloading feather files
Test CI windows runs for eager feather file reading
Read feather files eagerly, store to tempfile then read.
✔ Adding "docs" to .gitignore.
ℹ Leaving _pkgdown.yml unchanged.
☐ Modify _pkgdown.yml.
✔ Initializing empty, orphan branch "gh-pages" in GitHub repo "inbo/etn".
✔ GitHub Pages is publishing from:
• URL: "https://inbo.github.io/etn/"
• Branch: "main"
• Path: "/docs"
✔ Saving "r-lib/actions/examples/pkgdown.yaml@v2" to .github/workflows/pkgdown.yaml.
☐ Learn more at <https://github.com/r-lib/actions/blob/v2/examples/README.md>.
✔ Recording <https://inbo.github.io/etn/> as site's url in _pkgdown.yml.
✔ Adding "https://inbo.github.io/etn/" to URL.
Was planning to add myself, but R package guide recommends not to add authors already listed as authors: https://r-pkgs.org/vignettes.html#metadata

@PietrH up to you
Co-Authored-By: Peter Desmet <[email protected]>
Review package options vignette
Can be removed once v2.3.1 is merged into main
Use pkgdown GitHub action
@peterdesmet peterdesmet closed this Feb 3, 2026
@peterdesmet peterdesmet deleted the v2.3.1 branch February 3, 2026 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Release etn API update

3 participants