-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathREADME.Rmd
More file actions
78 lines (53 loc) · 4.58 KB
/
Copy pathREADME.Rmd
File metadata and controls
78 lines (53 loc) · 4.58 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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file and use devtools::build_readme() -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# GeoLocatoR <a href="https://github.com/GeoPressure/GeoLocatoR"><img src="man/figures/logo.png" align="right" height="139" alt="GeoLocatoR website" /></a>
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/GeoPressure/GeoLocatoR/actions/workflows/R-CMD-check.yaml)
[](https://github.com/GeoPressure/GeoLocatoR/actions/workflows/pkgdown.yaml)
[](https://github.com/GeoPressure/GeoLocatoR/actions/workflows/jarl-check.yml)
[](https://github.com/GeoPressure/GeoLocatoR/actions/workflows/format-check.yml)
[](https://app.codecov.io/gh/GeoPressure/GeoLocatoR)
[](https://doi.org/10.5281/zenodo.14670776)
<!-- badges: end -->
## 🚀 Overview
**GeoLocatoR** is an R package designed to help you create and work with the [GeoLocator Data Package (GeoLocator DP)](https://geopressure.org/GeoLocator-DP/), a standardized format for geolocator data that follows the [Data Package standard](https://datapackage.org/standard/data-package/), ensuring your data is organized, accessible, and ready to share.
## 🛰️ Main Features
- **Creates and reads GeoLocator Data Packages**: Create a GeoLocator Data Package object, add resources (data), and write it to your preferred directory. You can also read existing packages from disk (`read_gldp()`) or from Zenodo (`read_zenodo()`).
- **Integration with GeoPressureTemplate**: GeoLocatoR is compatible with [GeoPressureTemplate](https://github.com/GeoPressure/GeoPressureTemplate) — a template repository for analyzing geolocator data using GeoPressureR. Use both together to streamline your analysis and maintain a standardized project structure.
- **Built on frictionless**: This package is built using the [`frictionless`](https://docs.ropensci.org/frictionless/) package, adhering to the Frictionless Data standards for open data.
## 📦 What is a GeoLocator Data Package?
A **Data Package** is a lightweight format for packaging data using the [Data Package standard](https://datapackage.org/standard/data-package/). It provides a framework for organizing your data files, metadata, and descriptive information in a consistent and reusable manner. For geolocator data, this ensures that information about tagged birds, their movements, and associated metadata are all bundled into a single exchangeable package. Learn more about the GeoLocator DP standard [here](https://geopressure.org/GeoLocator-DP/).
## 🛠️ Installation
You can install GeoLocatoR from GitHub:
```r
# install.packages("pak")
pak::pkg_install("GeoPressure/GeoLocatoR")
# Install development version
pak::pkg_install("GeoPressure/GeoLocatoR@dev")
```
## 📖 How to use
Learn how to use GeoLocatoR with the dedicated part of the [GeoPressureManual](https://geopressure.org/GeoPressureManual/geolocator-intro.html).
<p align="center">
<a href="https://geopressure.org/GeoPressureManual/"><img src="https://github.com/GeoPressure/GeoPressureManual/raw/main/assets/cover.png" style="margin: 0 1rem 0 1rem;box-shadow: 0 .5rem 1rem rgba(0,0,0,.15);" align="center" width="250" height="328"></a>
</p>
## 🔧 Development note
GeoLocatoR uses bundled local GeoLocator-DP schemas (`inst/schemas`) for reading, validation, and upgrade. This keeps runtime fast and independent from online schema downloads. When GeoLocator-DP schemas change, refresh local files manually:
```r
source("data-raw/sync_schemas.R")
sync_gldp_schemas()
```
Versions synced by this script come from `.gldp_supported_versions` in `R/versioning.R`.
## 📚 Citation
If you use GeoLocatoR in your research, please cite it as follows:
> Nussbaumer, R., & Desmet, P. (2024). GeoLocatoR: R package for GeoLocator Data Package. Zenodo. https://doi.org/10.5281/zenodo.14670776. Available at: https://github.com/GeoPressure/GeoLocatoR