search

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

Use `x` instead of `mica` in examples section of function documentation #324

Closed damianooldoni closed 3 months ago

damianooldoni commented 4 months ago

All functions accepting a CamtrapDP object as argument have an example in documentation at least where mica is used. mica as camtrap DP object is not anymore loaded: we read such an object and we hold it in cache via the reexported camtrapdp function example_dataset(). So, in @example section of ROxygen documentation should start always with:

x <- example_dataset()

and then use x consequently.

Notice that I have already replaced mica with x in all the vignettes in PR #307 .

Agreed with @PietrH to NOT change mica elsewhere, for example in tests.

damianooldoni commented 3 months ago

Close as completed via #325