-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathREADME.Rmd
More file actions
57 lines (41 loc) · 3.15 KB
/
Copy pathREADME.Rmd
File metadata and controls
57 lines (41 loc) · 3.15 KB
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
---
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%"
)
```
# movepub
<!-- badges: start -->
[](https://github.com/inbo/movepub/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/inbo/movepub/)
[](https://www.repostatus.org/#active)
[](https://doi.org/10.5281/zenodo.15017582)
<!-- badges: end -->
movepub is an R package to prepare animal tracking data from [Movebank](https://www.movebank.org/) for publication in a research repository. With movepub you can document data with metadata following the [Data Package](https://specs.frictionlessdata.io/) standard and transform these to [Darwin Core](https://dwc.tdwg.org) and Ecological Metadata Language ([EML](https://eml.ecoinformatics.org/)) for publication to the Global Biodiversity Information Facility ([GBIF](https://www.gbif.org)) and the Ocean Biodiversity Information System ([OBIS](https://obis.org)).
To get started, see:
- [Prepare your study](https://www.movebank.org/cms/movebank-content/archiving-movebank#general_best_practice_tips): guidelines on how data owners should prepare their study in Movebank for archiving, prior to using this package.
- [Get started](https://inbo.github.io/movepub/articles/movepub.html): an introduction to the package’s main functionalities.
- [Function reference](https://inbo.github.io/movepub/reference/index.html): overview of all functions.
Note that Movebank users retain ownership of their data, and use should follow the [general Movebank terms of use](https://www.movebank.org/cms/movebank-content/general-movebank-terms-of-use) and any other license terms set by the owner.
## Installation
You can install the development version of movepub from [GitHub](https://github.com/) with:
``` r
# install.packages("pak")
pak::pak("inbo/movepub")
```
## Usage
This package supports two use cases:
- [Make a Movebank dataset "frictionless"](https://inbo.github.io/movepub/articles/movepub.html#frictionless) with `add_resource()`. This is useful when publishing a dataset on e.g. [Zenodo](https://zenodo.org).
- [Transform a Movebank dataset to Darwin Core](https://inbo.github.io/movepub/articles/movepub.html#dwc) with `write_dwc()`. This is necessary when publishing a dataset to [GBIF](https://www.gbif.org) and/or [OBIS](https://obis.org).
## Meta
- We welcome [contributions](https://inbo.github.io/movepub/CONTRIBUTING.html) including bug reports.
- License: MIT
- Get citation information for movepub in R with `citation("movepub")`.
- Please note that this project is released with a [Contributor Code of Conduct](https://inbo.github.io/movepub/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.