https://github.com/geopressure/geolocator
Facilitate the creation, use, and sharing of your geolocator datapackage
https://github.com/geopressure/geolocator
Last synced: 2 months ago
JSON representation
Facilitate the creation, use, and sharing of your geolocator datapackage
- Host: GitHub
- URL: https://github.com/geopressure/geolocator
- Owner: GeoPressure
- License: gpl-3.0
- Created: 2024-09-23T18:50:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-03T12:08:41.000Z (2 months ago)
- Last Synced: 2026-04-03T17:07:58.273Z (2 months ago)
- Language: R
- Homepage: https://geopressure.org/GeoLocatoR/
- Size: 8.01 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
- Citation: CITATION.cff
- Agents: AGENTS.md
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# GeoLocatoR 
[](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)
## 🚀 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).
## 🔧 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