-
Notifications
You must be signed in to change notification settings - Fork 40
/
Copy pathREADME.Rmd
111 lines (71 loc) · 3.62 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "# ",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# mapdeck
[](https://github.com/SymbolixAU/mapdeck/actions)
[
[](https://CRAN.R-project.org/package=mapdeck)
[](https://CRAN.R-project.org/package=mapdeck)
[](https://github.com/SymbolixAU/mapdeck)
## What is mapdeck?
An R library which lets you plot large data sets (as much as your GPU &
browser can handle), on interactive maps using Mapbox GL and Deck.gl
## What is mapbox?
> Mapbox is the location data platform for mobile and web applications. We provide building blocks to add location features like maps, search, and navigation into any experience you create.
- https://www.mapbox.com/about/company
## What is deck.gl?
> deck.gl is a WebGL-powered framework for visual exploratory data analysis of large datasets.
- https://deck.gl/#/
## How do I use it?
First you need to install it, either from CRAN
```r
install.packages("mapdeck")
```
Or from github (to get the latest development version)
```r
remotes::install_github("SymbolixAU/mapdeck")
```
If the github version fails to install, you'll probably need to update dependencies first
```r
remotes::install_github("dcooley/geometries")
remotes::install_github("dcooley/sfheaders")
remotes::install_github("SymbolixAU/spatialwidget")
```
Then everything you need to know to get you started is on the [home page](https://symbolixau.github.io/mapdeck/articles/mapdeck.html)
## Quick Start
Mapdeck uses [Mapbox maps](https://www.mapbox.com/), and to use Mapbox you need an [access token](https://docs.mapbox.com/help/how-mapbox-works/access-tokens/).
Once you've generate a token you can use their maps.
Call `mapdeck(token = 'your_token')` to generate a basic map. Then start adding layers by using one of the various `add_*()` functions.
```r
url <- 'https://raw.githubusercontent.com/plotly/datasets/master/2011_february_aa_flight_paths.csv'
flights <- read.csv(url)
flights$info <- paste0("<b>",flights$airport1, " - ", flights$airport2, "</b>")
mapdeck(token = key, style = mapdeck_style('dark')) %>%
add_arc(
data = flights
, origin = c("start_lon", "start_lat")
, destination = c("end_lon", "end_lat")
, stroke_from = "airport1"
, stroke_to = "airport2"
, tooltip = "info"
, layer_id = 'arclayer'
)
```
See the [Layers](https://symbolixau.github.io/mapdeck/articles/layers.html) page for more examples
## Getting help
For general help and advice the best place to ask is on [StackOverflow](https://stackoverflow.com/questions/tagged/mapdeck) (using the `mapdeck` tag).
If you've found a bug, or want a new feature added then use the [issue tracker](https://github.com/SymbolixAU/mapdeck/issues) on github.
I don't respond to emails asking for help because this is an open source package, and any advice should be kept open so everyone can benefit. (unless you want to pay me!)