https://github.com/r-spatial/rgeopackage

R package with helper tools in creating or handling GeoPackage files
https://github.com/r-spatial/rgeopackage

Last synced: 3 months ago
JSON representation

R package with helper tools in creating or handling GeoPackage files

• Host: GitHub
• URL: https://github.com/r-spatial/rgeopackage
• Owner: r-spatial
• License: gpl-3.0
• Created: 2021-03-25T16:37:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-22T05:27:54.000Z (almost 2 years ago)
• Last Synced: 2024-05-21T00:51:32.830Z (6 months ago)
• Language: R
• Homepage:
• Size: 116 KB
• Stars: 9
• Watchers: 4
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - r-spatial/rgeopackage - R package with helper tools in creating or handling GeoPackage files (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# rgeopackage

[![CRAN status](https://www.r-pkg.org/badges/version/rgeopackage)](https://CRAN.R-project.org/package=rgeopackage)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![Codecov test coverage](https://codecov.io/gh/r-spatial/rgeopackage/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-spatial/rgeopackage?branch=main)

The current goal of `rgeopackage` is to support reading and writing metadata associated with GeoPackage (gpkg) files and assist in writing reproducible GeoPackage files.

More generally, it aims to provide features not readily available in mainstream geospatial R packages, or perhaps difficult to discover.

## Installation

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

``` r

# install.packages("devtools")

remotes::install_github("r-spatial/rgeopackage")

```

## Overview

### Updating file timestamps

- `preset_timestamp()`: presets the file timestamp for usage by GDAL by setting the environment variable `OGR_CURRENT_DATE`.

The timestamp is adopted by GDAL during the entire session, unless `unset_timestamp()` is called.

- `amend_timestamp()`: overwrites timestamps in the `gpkg_contents` and `gpkg_metadata_reference` tables of an existing GeoPackage file.

By default, GDAL sets timestamps corresponding to system time, so GeoPackages change when rewriting. Both functions accept a `Date` or `POSIXct` object and reformat to comply with the [GeoPackage standard](https://www.geopackage.org/).

## Related R packages

- The [`sf` package](https://r-spatial.github.io/sf/) allows users to set GDAL configuration options in `sf::st_write()` using the `config_options` argument ([see sf issue #1618](https://github.com/r-spatial/sf/issues/1618#issuecomment-811231056)) and in `sf::st_read()` using the `options` argument (see [sf issue 1157](https://github.com/r-spatial/sf/issues/1157)). These options only affect the specific read or write statement and do not persist during the session. `sf` also includes a set of GDAL functions (e.g. `sf::gdal_metadata()`) that are not intended to be called directly by the user but could be used to access and edit GeoPackage metadata.

- The [`vapour` package](https://hypertidy.github.io/vapour/index.html) provides access to the basic read functions available in GDAL including GeoPackage contents and extension tables.