docs, pkdown

NEWS.md

@@ -1,5 +1,6 @@
 # leaflet.extras2 (development version)
 
+* Included [OSM Buildings](https://osmbuildings.org/documentation/leaflet/) plugin
 * Fix for roxygen2 > 7.0.0. #1491
 * The opened sidebar tab is returned as Shiny input using the `sidebar_tabs` ID.
 * allow `...` in `antpathOptions` to be able to set the pane (e.g.: `renderer= JS('L.svg({pane: "my-pane"})')`)

R/buildings.R

@@ -41,6 +41,15 @@ buildingsDependency <- function() {
 #' @seealso \url{https://github.com/kekscom/osmbuildings/} for more details on the OSM Buildings plugin and available properties.
 #' @family OSM-Buildings Plugin
 #' @export
+#' @examples
+#' library(leaflet)
+#' library(leaflet.extras2)
+#'
+#' leaflet()  %>%
+#'   addProviderTiles("CartoDB") %>%
+#'   addBuildings(group = "Buildings") %>%
+#'   addLayersControl(overlayGroups = "Buildings") %>%
+#'   setView(lng = 13.4, lat = 52.51, zoom = 15)
 addBuildings <- function(
   map,
   buildingURL = "https://{s}.data.osmbuildings.org/0.2/59fcc2e8/tile/{z}/{x}/{y}.json",

README.md

@@ -43,6 +43,7 @@ If you need a plugin that is not already implemented create an [issue](https://g
 -   [Mapkey Icons](https://github.com/mapshakers/leaflet-mapkey-icon)
 -   [Moving Markers](https://github.com/ewoken/Leaflet.MovingMarker)
 -   [OpenWeatherMap](https://github.com/trafficonese/leaflet-openweathermap)
+-   [OSMBuildings](https://github.com/kekscom/osmbuildings/tree/master)
 -   [Playback](https://github.com/hallahan/LeafletPlayback)
 -   [Reachability](https://github.com/traffordDataLab/leaflet.reachability)
 -   [Sidebar-v2](https://github.com/Turbo87/sidebar-v2)

_pkgdown.yml

@@ -64,6 +64,9 @@ reference:
     contents:
     - matches("Openweather")
     - matches("openweather")
+  - title: OSM Buildings
+    contents:
+    - matches("Building")
   - title: Playback
     contents:
     - matches("Playback")