Skip to content

Commit

Permalink
Update Camtrap DP description
Browse files Browse the repository at this point in the history
  • Loading branch information
peterdesmet committed Jul 20, 2023
1 parent a6997e6 commit 33b88d9
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,11 @@ knitr::opts_chunk$set(

Camtraptor is an R package to read, explore and visualize Camera Trap Data Packages (Camtrap DP). [Camtrap DP](https://tdwg.github.io/camtrap-dp/) is a community developed data exchange format for this type of data. With camtraptor you can read and filter data, create overviews of observed species, relative abundance or effort, and plot these data on a map.


## Camtrap DP

camtraptor v0.20 is able to support both the older Camtrap DP 0.1.6 and the newer Camtrap DP 1.0-rc.1. To do so, we are applying a **back-conversion** to the data packages written using Camtrap DP version 1.0-rc.1. In the meantime we are also working on [camtraptor v1.0]((https://github.com/inbo/camtraptor/milestone/3) which will introduce breaking changes and will fully support only the newer Camtrap DP 1.0-rc.1.
Camtraptor currently uses the legacy Camtrap DP 0.1.6 for its internal data model. `read_camtrap_dp()` will automatically down-convert Camtrap DP 1.0-rc.1 datasets to that legacy model to avoid introducing breaking changes. The downside is that some newer properties like `media.filePublic` and `observations.eventEnd` are ignored when reading data.

The upcoming [camtraptor v1.0](https://github.com/inbo/camtraptor/milestone/3) will update the internal data model to Camtrap DP 1.0 and drop support for Camtrap DP 0.1.6. This is a breaking change that will be accompanied by a number of other major changes. Future versions of camtraptor will always use the latest version of Camtrap DP and up-convert legacy datasets to that model.

## Get Started

Expand Down

1 comment on commit 33b88d9

@damianooldoni
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😲 Beautifully written! 👍

Please sign in to comment.