etn/README.Rmd at main · inbo/etn · GitHub

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
---
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%"
)
```

# etn <a href="https://inbo.github.io/etn/"><img src="man/figures/logo.png" align="right" height="138" alt="etn website" /></a>

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/etn)](https://CRAN.R-project.org/package=etn)
[![R-universe version](https://inbo.r-universe.dev/etn/badges/version)](https://inbo.r-universe.dev/etn)
[![R-CMD-check](https://github.com/inbo/etn/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/inbo/etn/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/inbo/etn/branch/main/graph/badge.svg)](https://app.codecov.io/gh/inbo/etn)
[![repo status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15235747.svg)](https://doi.org/10.5281/zenodo.15235747)
<!-- badges: end -->

etn is an R package to access data from the [European Tracking Network (ETN)](https://www.lifewatch.be/etn/). With etn you can query metadata (animals, tags, deployments, receivers, projects) and data (acoustic detections, sensor data) from the ETN database and use these in your analyses. Data access requires user credentials and is subject to a [data policy](https://europeantrackingnetwork.org/en/4-data-policy-permissions-citation-guidelines-and-data-use).

To get started, see:

- [Configure credentials](https://inbo.github.io/etn/articles/authentication.html).
- [Function reference](https://inbo.github.io/etn/reference/index.html): overview of all functions.
- [Explore acoustic telemetry data](https://inbo.github.io/etn/articles/acoustic_telemetry.html).

## Installation

You can install the development version of etn from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("inbo/etn")
```

## Usage

Before you can access data from the European Tracking Network, you need to register for a MarinePass account at the Flanders Marine Institute (VLIZ). See [authentication](https://inbo.github.io/etn/articles/authentication.html#dont-have-an-account-to-etn) for instructions.

With etn you can query ETN (meta)data:

```{r example}
library(etn)

# Get animal metadata for a project
get_animals(animal_project_code = "2014_demer")

# Get acoustic detections for a tag and time period
get_acoustic_detections(
  tag_serial_number = "1171781",
  start_date = "2014-06-01",
  end_date = "2014-06-15"
)
```

## Meta

- We welcome [contributions](.github/CONTRIBUTING.md) including bug reports.
- License: MIT
- Get citation information for etn in R doing `citation("etn")`.
- 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.