-
Notifications
You must be signed in to change notification settings - Fork 74
/
README.Rmd
121 lines (86 loc) · 6.06 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
---
output:
github_document:
html_preview: false
---
```{r, echo = FALSE}
knitr::opts_chunk$set(fig.retina = 2, fig.path = "README_figs/README-")
```
```{r, echo = FALSE}
description <- readLines(system.file("DESCRIPTION", package = "leaflet.extras"))
version <- gsub(" ", "", gsub("Version:", "", grep("Version:", description, value = TRUE)))
last_changed <- gsub("-", "--", Sys.Date())
```
[](https://github.com/trafficonese/leaflet.extras/actions/workflows/R-CMD-check.yaml)
[](https://CRAN.R-project.org/package=leaflet.extras)
[](https://cran.r-project.org/web/checks/check_results_leaflet.extras.html)
[](/commits/master)
[](https://opensource.org/licenses/GPL-3.0)
[](https://cran.r-project.org/package=leaflet.extras)
[](https://cran.r-project.org/package=leaflet.extras)
[](https://app.codecov.io/gh/trafficonese/leaflet.extras?branch=master)
## leaflet.extras
The goal of `leaflet.extras` package is to provide extra functionality to the [leaflet](https://cran.r-project.org/package=leaflet.extras) R package using various [leaflet plugins](https://leafletjs.com/plugins).
### Installation
For CRAN version
```{r, eval=FALSE}
install.packages("leaflet.extras")
```
For latest development version
```{r, eval=FALSE}
remotes::install_github("trafficonese/leaflet.extras")
```
### Progress
Plugins integrated so far ...
- [Pulse Icon](https://github.com/mapshakers/leaflet-icon-pulse)
- [Weather Markers](https://github.com/tallsam/Leaflet.weather-markers)
- [Leaflet Heat](https://github.com/Leaflet/Leaflet.heat)
- [webgl-heatmap](https://github.com/ursudio/leaflet-webgl-heatmap)
- [Tile Caching](https://github.com/MazeMap/Leaflet.TileLayer.PouchDBCached)
- [Leaflet Hash](https://github.com/mlevans/leaflet-hash)
- [Fullscreen Control](https://github.com/Leaflet/Leaflet.fullscreen)
- [WMS Legend](https://github.com/kartoza/leaflet-wms-legend)
- [Omnivore](https://github.com/mapbox/leaflet-omnivore): Allows adding data from various geospatial file formats.
* GeoJSON
* TopoJSON
* KML
* CSV
* GPX
* ~~WKT~~: Will not be implemented.
* ~~Polyline~~: Will not be implemented.
- [Leaflet.Draw](https://github.com/Leaflet/Leaflet.draw) & [Style Editor](https://github.com/dwilhelm89/Leaflet.StyleEditor)
- [Leaflet.Geodesic](https://github.com/henrythasler/Leaflet.Geodesic)
- [Leaflet-measure-path](https://github.com/ProminentEdge/leaflet-measure-path)
- [Leaflet-search](https://github.com/stefanocudini/leaflet-search)
- [Leaflet-GPS](https://github.com/stefanocudini/leaflet-gps)
- [Leaflet.Sleep](https://github.com/CliffCloud/Leaflet.Sleep)
- [Bing Tiles](https://github.com/shramov/leaflet-plugins/tree/v2)
- [Bounce Marker](https://github.com/maximeh/leaflet.bouncemarker)
- [Grouped LayerControl](https://github.com/trafficonese/leaflet-groupedlayercontrol)
If you need a plugin that is not already implemented create an [issue](https://github.com/trafficonese/leaflet.extras/issues/new).
See the [FAQ](#FAQ) section below for details.
### Documentation
The R functions have been documented using roxygen, and should provide enough help to get started on using a feature. However some plugins have lots of options and it's not feasible to document every single detail. In such cases you are encouraged to check the plugin's documentation.
There are also plenty of [examples](https://github.com/trafficonese/leaflet.extras/tree/master/inst/examples) available.
### FAQ
_I want to use a certain leaflet plugin not integrated so far._
- **Good Solution**: Create issues for plugins you wish incorporated but before that, search the existing issues to see if issue
already exists and if so comment on that issue instead of creating duplicates.
- **Better Solution**: It would help in prioritizing if you can include additional details like why you need the plugin, how helpful will it be to everyone etc.
- **Best Solution**: Code it yourself and submit a pull request. This is the fastest way to get a plugin into the package.
Also take a look at this Gist to [include arbitrary Leaflet JS plugins](https://gist.github.com/jcheng5/c084a59717f18e947a17955007dc5f92)
_I submitted an issue for a plugin long time ago but it is still not available._
This package is being developed purely on a voluntary basis on spare time without any monetary compensation. So the development progress can stall at times. It may also not be possible to prioritize one-off requests that no one else is interested in. Getting more people interested in a feature request will help prioritize development. Other option is to contribute code. That will get you added to the contributor list and a thanks tweet.
_I found a bug._
- **Good Solution**: Search existing issue list and if no one has reported it create a new issue.
- **Better Solution**: Along with issue submission provide a minimal reproducible code sample.
- **Best Solution**: Fix the issue and submit a pull request. This is the fastest way to get a bug fixed.
### Development
To make additions to the plugin dependencies, please add the plugin using `npm`. Make sure it is compiled within the `webpack.config.js`. Finally, make sure `htmlwidgets` finds it within your plugin's dependency function.
To build the latest version of the plugins, please make sure `Node.js` is installed on your system, then run:
```
npm install
npm run build
```
### Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.