forked from Fernandez-Lab-WSU/quadkeyr
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
130 lines (100 loc) · 5.72 KB
/
README.Rmd
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# quadkeyr <img src="vignettes/logo.png" align="right" height="150"/>
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/ropensci/quadkeyr/actions/workflows/check-release.yaml)
[](https://github.com/<org>/<repo>/actions?query=workflow%3Apkgcheck)
[](https://codecov.io/gh/Fernandez-Lab-WSU/quadkeyr)
[](https://github.com/ropensci/software-review/issues/619)
[](https://joss.theoj.org/papers/3301002821465f4f160e7ce272c00c6f)
<!-- 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](https://learn.microsoft.com/en-us/bingmaps/articles/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](https://dataforgood.facebook.com/).
### 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.
```{r qks, echo = FALSE, out.width= "70%", fig.align='center'}
knitr::include_graphics("https://github.com/ropensci/quadkeyr/blob/main/docs/articles/bing_quadkeys.jpg?raw=true")
```
<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)**](https://docs.ropensci.org/quadkeyr/articles/quadkey_to_sf_conversion.html)
`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](https://learn.microsoft.com/en-us/bingmaps/articles/bing-maps-tile-system) for converting QuadKeys to and from tiles, pixels, and geographic coordinates.
```{r w1, echo = FALSE, out.width= "80%", fig.align='center'}
knitr::include_graphics("vignettes/workflow_quadkey.png")
```
2. [**Generate Raster Images from Quadkey-Identified Data**](https://docs.ropensci.org/quadkeyr/articles/quadkey_identified_data_to_raster.html)
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.
```{r w2, echo = FALSE, out.width= "80%", fig.align='center'}
knitr::include_graphics("vignettes/workflow_raster.png")
```
3. [**Convert Meta (Facebook) Mobility QuadKey-identified Datasets into Raster Files**](https://docs.ropensci.org/quadkeyr/articles/facebook_mobility_csvs_to_raster_files.html)
Convert Meta (Facebook) mobility data `.csv` files into `.tif` files
by day and hour reported.
```{r w3, echo = FALSE, out.width= "80%", fig.align='center'}
knitr::include_graphics("vignettes/workflow_facebook.png")
```
4. [**Offer an App for visualizing QuadKeys on a map**](https://docs.ropensci.org/quadkeyr/articles/quadkey_visualization_app.html)
Introduce a QuadKey visualization application enabling users
to validate function outcomes.
## Install `quadkeyr`
### R-Universe
For the latest development version of `quadkeyr`:
```r
install.packages("quadkeyr",
repos = "https://ropensci.r-universe.dev")
```
### GitHub
You can install the development version of `quadkeyr` from [GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("Fernandez-Lab-WSU/quadkeyr")
```
## Code of Conduct
Please note that this package is released with a [Contributor
Code of Conduct](https://ropensci.org/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](https://github.com/ropensci/quadkeyr/blob/main/.github/CONTRIBUTING.md)
## Links of interest
- [Bing Maps Tile Systems - Microsoft](https://learn.microsoft.com/en-us/bingmaps/articles/bing-maps-tile-system)
- [R - `slippymath`: Slippy Map Tile Tools](https://cran.r-project.org/web/packages/slippymath/index.html)
- [Python - `pyquadkey2`](https://docs.muetsch.io/pyquadkey2/)
- [Python - `python-quadkey`](https://github.com/CartoDB/python-quadkey)
- [Python - `mercantile`](https://pypi.org/project/mercantile/)
- [Rust - `geo-quadkey-rs`](https://lib.rs/crates/geo-quadkey-rs)
- [TypeScript - `quadkey-tilemath`](https://github.com/glassonion1/quadkey-tilemath)
- [GeoCode Map viewer](https://tools.9revolution9.com/geo/geocode/)