Add example docs #34

DESCRIPTION

@@ -85,4 +85,4 @@ Suggests:
     stars
 Encoding: UTF-8
 LazyData: false
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.0

NAMESPACE

@@ -11,6 +11,7 @@ export(addImageQuery)
 export(addLocalFile)
 export(addLogo)
 export(addMouseCoordinates)
+export(addPMTiles)
 export(addRasterRGB)
 export(addReactiveFeatures)
 export(addStarsImage)

R/pmtiles.R

@@ -1,3 +1,22 @@
+#' Add vector tiles
+#'
+#' This function add vector tiles, as created by
+#' [tippecanoe](https://github.com/protomaps/tippecanoe), a software project
+#' that builds vector tiles stored as .mbtiles files originally developed by
+#' MapBox but subsequently maintained by protomaps.
+#'
+#'
+#' @param map A \code{leaflet} or \code{mapview} map.
+#' @param url The URL of vector tiles to add
+#' @param layerName The name of the layer from the tiles to add
+#' @param style Style elements to add
+#' @param layerId The id of the layer to add
+#' @param group The group that the layer belongs to if any
+#' @examples
+#' library(leaflet)
+#' u_mbtiles = "https://www.carbon.place/tiles/pct/{x}/{y}/{z}.pbf"
+#' leaflet() %>% addProviderTiles("OpenStreetMap") %>% addPMTiles(u_mbtiles, layerName = "bicycle")
+#' @export
 addPMTiles = function(
     map
     , url
@@ -58,6 +77,7 @@ addPMTiles = function(
 #' @param color line color
 #' @param do_stroke logical, whether polygon borders should be drawn
 #' @param width line width
+#' @inheritParams addPMTiles
 #'
 #' @export
 paintRules = function(

leafem.Rproj

@@ -15,6 +15,7 @@ LaTeX: pdfLaTeX
 StripTrailingWhitespace: Yes
 
 BuildType: Package
+PackageCleanBeforeInstall: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
 PackageCheckArgs: --as-cran
 PackageRoxygenize: rd,collate,namespace