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

Refactor `read_camtrap_dp()` function #298

Closed damianooldoni closed 4 months ago

damianooldoni commented 7 months ago

IMPORTANT: OUTDATED: we will not remove this function. See https://github.com/inbo/camtraptor/issues/298#issuecomment-2112636999 here below.


The reading functionality has been moved to camtrapdp package. Same function name.

This function must therefore be removed within camtraptor.

damianooldoni commented 7 months ago

Contrarely to what I thought few days ago, I am more and more convinced that camtraptor should not support reading functionalities anymore. In other words, no wrappers around camtrapdp's read_camtrap_dp() function.

I see a similarity with tidyverse ecosystem where dplyr is not reading a file, but starts from a data.frame. camtrapdp is the "readr", camtraptor the "dplyr".

I spoke about this with @PietrH during a coffee break and he agrees.

@peterdesmet, @sangovae, any opinion is welcome.

damianooldoni commented 5 months ago

After a coffie corner ☕ discussion, we decided to still maintain the reading functionality within camtraptor. Of course, it will use camtrapdp under the hood.

In this way:

We also agreed to name the function as in camtrapdp, i.e. read_camtrapdp(). The existing function with an extra underscore, read_camtrap_dp() will get deprecated in version 1.0. To be removed a year later or so.

The argument path, which is deprecated since years, will be not supported anymore and will be removed.