GeoLocatoR

🚀 Overview

GeoLocatoR is an R package designed to help you create and work with the GeoLocator Data Package (GeoLocator DP), a standardized format for geolocator data that follows the Data Package standard, 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 — 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 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. 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.

🛠️ Installation

You can install GeoLocatoR from GitHub:

# 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.

🔧 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:

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