inbo / camtraptor

Camtraptor is an R package to read, explore and visualize Camera Trap Data Packages (Camtrap DP)
https://inbo.github.io/camtraptor/
MIT License
10 stars 2 forks source link

Update internal data model to Camtrap DP v1.0 #251

Open peterdesmet opened 1 year ago

peterdesmet commented 1 year ago

Suggested in camtraptor July 2023 coding sprint

Camtraptor v0.20 and earlier use Camtrap DP v0.1.6 for the internal data model. You can recognize this model by e.g. the use of sequenceID over eventID, but it has many other differences with the latest Camtrap DP version. Version v0.1.6 was implemented in camtraptor, since that was the (first) Camtrap DP version supported as export format in Agouti and Trapper. Both Agouti and Trapper are now changing to Camtrap DP v1.0, which camtraptor v0.20 will be able to read (#223) by internally converting to the legacy v0.1.6 version. This is done so that users are not faced with breaking changes in column names etc.

We should however move to Camtrap DP v1.0 as the internal model for camtraptor, since that is first version to officially support. It will also take away the discrepancy between Camtrap DP v1.0 files and how it looks inside camtraptor (because of the silent conversion to the legacy format by read_camtrap_dp()). Since it is a breaking change, it requires a major version bump (camtraptor 1.0).

This change will affect all functions, but those will undergo substantial (breaking) changes anyway as part of milestone v1.0.

Camtrap DP will also not stay at version 1.0 indefinitely, and camtraptor should be ready for (minor) versions updates. We suggest:

damianooldoni commented 4 months ago

We leave this issue open until camtraptor v1.0 will be released.