knitr::opts_chunk$set(fig.retina = 2, fig.path = "README_figs/README-")
description <- readLines(system.file("DESCRIPTION", package = "leaflet.extras")) version <- gsub(" ", "", gsub("Version:", "", grep("Version:", description, value = TRUE))) last_changed <- gsub("-", "--", Sys.Date())
The goal of leaflet.extras
package is to provide extra functionality to the leaflet R package using various leaflet plugins.
For CRAN version
install.packages("leaflet.extras")
For latest development version
remotes::install_github("trafficonese/leaflet.extras")
Plugins integrated so far ...
If you need a plugin that is not already implemented create an issue. See the FAQ section below for details.
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 available.
I want to use a certain leaflet plugin not integrated so far.
Also take a look at this Gist to include arbitrary Leaflet JS plugins
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.
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
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.