add single examples to all functions if possible

R/basemapLayers.R

@@ -35,10 +35,9 @@ esriBasemapLabels <- list(
 #' @param layerId Unique ID for the layer
 #' @param group The group this layer belongs to.
 #' @param options Basemap Layer Options. You can pass \code{\link[leaflet]{tileOptions}()}.
-#' @examples \dontrun{
+#' @examples
 #' leaflet() %>%
 #'    addEsriBasemapLayer(esriBasemapLayers$Oceans, autoLabels = TRUE)
-#' }
 #' @export
 addEsriBasemapLayer <- function(
   map, key, autoLabels = FALSE,

R/dynamicMapLayers.R

@@ -71,6 +71,24 @@ dynamicMapLayerOptions <- function(
 #' @param layerId A unique ID for the layer.
 #' @param group The name of the group this layer should be added to.
 #' @export
+#' @examples
+#' popupFunc <- htmlwidgets::JS(
+#'   "function (error, featureCollection) {
+#'     if (error || featureCollection.features.length === 0) {
+#'       return false;
+#'     } else {
+#'     return \"Risk Level: \" + featureCollection.features[0].properties.CLASS_DESC;
+#'     }
+#'   }")
+#'
+#' leaflet() %>% setView(-96.8, 38.5, 4) %>%
+#'   addEsriBasemapLayer(esriBasemapLayers$Gray, autoLabels = TRUE) %>%
+#'   addEsriDynamicMapLayer(
+#'     url = "https://maps7.arcgisonline.com/arcgis/rest/services/USDA_USFS_2014_Wildfire_Hazard_Potential/MapServer", popupFunction = popupFunc,
+#'     options = dynamicMapLayerOptions(useCors = FALSE))
+#'
+#' ## for more examples see
+#' # browseURL(system.file("examples/dynamicMapLayers.R", package = "leaflet.esri"))
 addEsriDynamicMapLayer <- function(
   map, url,
   options = dynamicMapLayerOptions(),

R/featureLayers.R

@@ -119,6 +119,19 @@ featureLayerOptions <- function(
 #' @param fitBounds Whether to set the maps bounds to fit the data in the featureLayer
 #'   options
 #' @export
+#' @examples
+#' leaflet() %>%
+#'   addEsriBasemapLayer(esriBasemapLayers$Streets) %>%
+#'   setView(-122.667, 45.526, 13) %>%
+#'   addEsriFeatureLayer(
+#'     url = "https://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Heritage_Trees_Portland/FeatureServer/0",
+#'     useServiceSymbology = TRUE,
+#'     labelProperty = "COMMON_NAM", labelOptions = labelOptions(textsize = "12px"),
+#'     popupProperty = JS("function(feature) { return L.Util.template(\"<h3>{COMMON_NAM}</h3><hr /><p>This tree is located at {ADDRESS} and its scientific name is {SCIENTIFIC}.\", feature.properties);}"))
+#'
+#' ## for more examples see
+#' # browseURL(system.file("examples/featureLayers.R", package = "leaflet.esri"))
+#' # browseURL(system.file("examples/multipleFeatureLayers.R", package = "leaflet.esri"))
 addEsriFeatureLayer <- function(
   map, url, useServiceSymbology = FALSE,
   options = featureLayerOptions(),

R/imageMapLayers.R

@@ -80,6 +80,16 @@ imageMapLayerOptions <- function(
 #' @param layerId A unique ID for the layer.
 #' @param group The name of the group this layer should be added to.
 #' @export
+#' @examples
+#' leaflet() %>%
+#'   addEsriBasemapLayer(esriBasemapLayers$Gray) %>%
+#'   setView(30, 0, 3) %>%
+#'   addEsriImageMapLayer(
+#'     url = "https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/World/MODIS/ImageServer",
+#'     options = imageMapLayerOptions(useCors = FALSE))
+#'
+#' ## for more examples see
+#' # browseURL(system.file("examples/imageMapLayers.R", package = "leaflet.esri"))
 addEsriImageMapLayer <- function(
   map, url,
   options = imageMapLayerOptions(),

R/tiledMapLayers.R

@@ -35,6 +35,13 @@ tiledMapLayerOptions <- function(
 #' @param layerId A unique ID for the layer.
 #' @param group The name of the group this layer should be added to.
 #' @export
+#' @examples
+#' leaflet() %>% setView(-81.47, 30.70, 12) %>%
+#'   addEsriTiledMapLayer(
+#'     url = "https://services.arcgisonline.com/ArcGIS/rest/services/USA_Topo_Maps/MapServer")
+#'
+#' ## for more examples see
+#' # browseURL(system.file("examples/tiledMapLayers.R", package = "leaflet.esri"))
 addEsriTiledMapLayer <- function(
   map, url,
   options = tiledMapLayerOptions(),