<!-- README.md is generated from README.Rmd. Please edit that file -->

quadkeyr <img src="vignettes/logo.webp" align="right" height="150"/>

<!-- badges: start -->

<!-- badges: end -->

What can this package do for you?

The quadkeyr R package presents a comprehensive toolkit tailored for generating raster images from Quadkey-Identified data within Microsoft’s Bing Maps Tile System. Designed to integrate Quadkey-Identified data into R workflows, this package facilitates the creation of QuadKey grids and raster images and introduces specialized functions for the processing of Meta Mobility data, previously referred to as Facebook mobility data.

What are QuadKeys in Tile Maps?

Tile maps divide the Earth’s surface into a grid of tiles, with each tile corresponding to a specific geographic area at various zoom levels.

QuadKeys represent a location on a map by encoding its hierarchical spatial position as a sequence of characters. They provide an efficient method to address and retrieve specific map tiles, facilitating rapid display within mapping applications.

<img src="man/figures/README-qks-1.png" width="70%" style="display: block; margin: auto;" /> <p style="text-align: center"> The QuadKey of any tile starts with the QuadKey of its parent tile (the containing tile at the previous level). Image extracted from Microsoft’s Bing Maps Tile System webpage. </p>

---

The goal of quadkeyr is to:

1. Convert a QuadKey to a Simple Features data.frame (and more) quadkeyr provides functions to convert a QuadKey to a sf POINT data.frame or sf POLYGON data.frame. Additionally, it offers all the R functions described in the official documentation for converting QuadKeys to and from tiles, pixels, and geographic coordinates.

<img src="man/figures/README-w1-1.png" width="80%" style="display: block; margin: auto;" />

2. Generate Raster Images from Quadkey-Identified Data Complete a grid of QuadKeys within a specified area and zoom level, and create a stars raster. You can also directly convert QuadKeys in a data.frame column into an sf POLYGON data.frame.

<img src="man/figures/README-w2-1.png" width="80%" style="display: block; margin: auto;" />

3. Convert Meta (Facebook) Mobility QuadKey-identified Datasets into Raster Files Convert Meta (Facebook) mobility data .csv files into .tif files by day and hour reported.

<img src="man/figures/README-w3-1.png" width="80%" style="display: block; margin: auto;" />

4. Offer an App for visualizing QuadKeys on a map Introduce a QuadKey visualization application enabling users to validate function outcomes.

Install quadkeyr

R-Universe

For the latest development version of quadkeyr:

install.packages("quadkeyr",
                 repos = "https://ropensci.r-universe.dev")

GitHub

You can install the development version of quadkeyr from GitHub with:

# install.packages("remotes")
remotes::install_github("ropensci/quadkeyr")

CRAN

You can install the latest version of quadkeyr from CRAN with:

install.packages("quadkeyr")

Code of Conduct

Please note that this package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Contribute

If you’d like to contribute to this project, please follow the contributing guidelines

Links of interest

• Bing Maps Tile Systems - Microsoft
• R - slippymath: Slippy Map Tile Tools
• Python - pyquadkey2
• Python - python-quadkey
• Python - mercantile
• Rust - geo-quadkey-rs
• TypeScript - quadkey-tilemath
• GeoCode Map viewer