-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME.Rmd
81 lines (57 loc) · 3.7 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# camtraptor <a href="https://inbo.github.io/camtraptor"><img src="man/figures/logo.png" align="right" height="137" alt="camtraptor website" /></a>
<!-- badges: start -->
[](https://CRAN.R-project.org/package=camtraptor)
[](https://github.com/inbo/camtraptor/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/inbo/camtraptor/)
[](https://www.repostatus.org/#active)
<!-- badges: end -->
Camtraptor is an R package to read, explore and visualize Camera Trap Data Packages (Camtrap DP). [Camtrap DP](https://camtrap-dp.tdwg.org) 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 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 datasets to that legacy model to avoid introducing breaking changes. The downside is that some newer properties like `deployments.cameraDepth`, `media.filePublic` and `observations.eventEnd` are removed 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
To get started, see:
- [Vignettes](https://inbo.github.io/camtraptor/articles/): tutorials showcasing functionality.
- [Function reference](https://inbo.github.io/camtraptor/reference/index.html): overview of all functions.
## Installation
You can install the development version of camtraptor from [GitHub](https://github.com/inbo/camtraptor) with:
``` r
# install.packages("devtools")
devtools::install_github("inbo/camtraptor")
```
While we support older versions of R up to 3.5, we recommend using R 4.0.0 or higher.
## Example
Get the taxonomic coverage for an example Camera Trap Data Package `mica`:
```{r}
library(camtraptor)
get_species(mica)
```
Filter observations in `mica` on female mallards and map the number of individuals per deployment location:
```{r}
map_dep(
mica,
feature = "n_individuals",
species = "Anas platyrhynchos",
sex = "female"
)
```
## camtraptor vs camtrapR and activity
Camtraptor provides and bundles much needed functionality to read, explore and visualize Camera Trap Data Packages. Over time we hope to include some or all of this functionality in widely used R packages such as [camtrapR](https://cran.r-project.org/package=camtrapR) and [activity](https://cran.r-project.org/package=activity).
## Meta
- We welcome [contributions](.github/CONTRIBUTING.md) including bug reports.
- License: MIT
- Get citation information for camtraptor in R doing `citation("camtraptor")`.
- Please note that this project is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.