Merge pull request #301 from bhaskarvk/milestone/v1.1

Batch 1 Milestone/v1.1

Author: bhaskarvk

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: leaflet
 Type: Package
 Title: Create Interactive Web Maps with the JavaScript 'Leaflet' Library
-Version: 1.0.2.9002
+Version: 1.0.2.9003
 Date: 2016-09-17
 Authors@R: c(
       person("Joe", "Cheng", email = "[email protected]", role = c("aut", "cre")),

NAMESPACE

@@ -54,9 +54,15 @@ export(colorFactor)
 export(colorNumeric)
 export(colorQuantile)
 export(createLeafletMap)
+export(derivePoints)
+export(derivePolygons)
 export(dispatch)
 export(easyButton)
 export(easyButtonState)
+export(evalFormula)
+export(expandLimits)
+export(expandLimitsBbox)
+export(filterNULL)
 export(fitBounds)
 export(getMapData)
 export(hideGroup)
@@ -75,6 +81,7 @@ export(leafletProxy)
 export(makeAwesomeIcon)
 export(makeIcon)
 export(mapOptions)
+export(markerClusterDependencies)
 export(markerClusterOptions)
 export(markerOptions)
 export(pathOptions)
@@ -96,6 +103,7 @@ export(removeShape)
 export(removeTiles)
 export(removeTopoJSON)
 export(renderLeaflet)
+export(safeLabel)
 export(scaleBarOptions)
 export(setMaxBounds)
 export(setView)

NEWS

@@ -1,6 +1,8 @@
 leaflet 1.1
 --------------------------------------------------------------------------------
 
+* Fixed Issues #288, #261, #283
+
 * Added 2 new plugins Proj4Leaflet (PR #294) and EasyButton (PR #295).
 
 * Upgraded existing plugins to their respective latest versions and added missing/new functionality from those plugins. (PR #293)

R/layers.R

@@ -1,5 +1,8 @@
-# Evaluate list members that are formulae, using the map data as the environment
-# (if provided, otherwise the formula environment)
+#' Evaluate list members that are formulae, using the map data as the environment
+#' (if provided, otherwise the formula environment)
+#' @param list with members as formulae
+#' @param data map data
+#' @export
 evalFormula = function(list, data) {
   evalAll = function(x) {
     if (is.list(x)) {
@@ -15,9 +18,13 @@ evalFormula = function(list, data) {
 # polygon lists (returned from polygonData()) use `attr(x, "bbox")` (though at
 # least they are the same shape as the Spatial bounding boxes).
 
-# Notifies the map of new latitude/longitude of items of interest on the map, so
-# that we can expand the limits (i.e. bounding box). We will use this as the
+#' Notifies the map of new latitude/longitude of items of interest on the map
+# So that we can expand the limits (i.e. bounding box). We will use this as the
 # initial view if the user doesn't explicitly specify bounds using fitBounds.
+#' @param map map object
+#' @param lat vector of latitudes
+#' @param lng vector of longitudes
+#' @export
 expandLimits = function(map, lat, lng) {
   if (is.null(map$x$limits)) map$x$limits = list()
 
@@ -33,8 +40,11 @@ expandLimits = function(map, lat, lng) {
   map
 }
 
-# Same as expandLimits, but takes a polygon (that presumably has a bbox attr)
-# rather than lat/lng.
+#' Same as expandLimits, but takes a polygon (that presumably has a bbox attr)
+#' rather than lat/lng.
+#' @param map map object
+#' @param poly A spatial object representing a polygon.
+#' @export
 expandLimitsBbox = function(map, poly) {
   bbox = attr(poly, "bbox", exact = TRUE)
   if (is.null(bbox)) stop("Polygon data had no bbox")
@@ -358,6 +368,7 @@ WMSTileOptions = function(
 #'   the latitude column from \code{data})
 #' @param popup a character vector of the HTML content for the popups (you are
 #'   recommended to escape the text using \code{\link[htmltools]{htmlEscape}()}
+#' @param popupOptions A Vector of \code{\link{popupOptions}} to provide popups
 #'   for security reasons)
 #' @param layerId the layer id
 #' @param group the name of the group the newly created layers should belong to
@@ -380,6 +391,7 @@ addPopups = function(
     expandLimits(pts$lat, pts$lng)
 }
 
+#' options for specify popup realted options
 #' @param className a CSS class name set on an element
 #' @param
 #' maxWidth,minWidth,maxHeight,autoPan,keepInView,closeButton,zoomAnimation,closeOnClick
@@ -421,7 +433,9 @@ clearPopups = function(map) {
   invokeMethod(map, NULL, 'clearPopups')
 }
 
-# Helper Function to create a safe label
+#' Helper Function to create a safe label
+#' @describeIn map-layers Create a label with sanitized text/html
+#' @export
 safeLabel <- function(label, data) {
   if (is.null(label)) {
     return(label)
@@ -484,6 +498,7 @@ addMarkers = function(
   map, lng = NULL, lat = NULL, layerId = NULL, group = NULL,
   icon = NULL,
   popup = NULL,
+  popupOptions = NULL,
   label = NULL,
   labelOptions = NULL,
   options = markerOptions(),
@@ -518,8 +533,9 @@ addMarkers = function(
 
   pts = derivePoints(data, lng, lat, missing(lng), missing(lat), "addMarkers")
   invokeMethod(
-    map, data, 'addMarkers', pts$lat, pts$lng, icon, layerId, group, options, popup,
-    clusterOptions, clusterId, safeLabel(label, data), labelOptions
+    map, data, 'addMarkers', pts$lat, pts$lng, icon, layerId, group, options,
+    popup, popupOptions, clusterOptions, clusterId,
+    safeLabel(label, data), labelOptions
   ) %>% expandLimits(pts$lat, pts$lng)
 }
 
@@ -549,6 +565,9 @@ addLabelOnlyMarkers = function(
              data = data)
 }
 
+#' Adds marker-cluster-plugin HTML dependency
+#' @export
+#' @describeIn map-layers add maker cluster plugin
 markerClusterDependencies = function() {
   list(
     htmltools::htmlDependency(
@@ -802,6 +821,7 @@ addCircleMarkers = function(
   fillOpacity = 0.2,
   dashArray = NULL,
   popup = NULL,
+  popupOptions = NULL,
   label = NULL,
   labelOptions = NULL,
   options = pathOptions(),
@@ -818,7 +838,8 @@ addCircleMarkers = function(
     map$dependencies = c(map$dependencies, markerClusterDependencies())
   pts = derivePoints(data, lng, lat, missing(lng), missing(lat), "addCircleMarkers")
   invokeMethod(map, data, 'addCircleMarkers', pts$lat, pts$lng, radius,
-      layerId, group, options, clusterOptions, clusterId, popup, safeLabel(label, data), labelOptions) %>%
+               layerId, group, options, clusterOptions, clusterId,
+               popup, popupOptions, safeLabel(label, data), labelOptions) %>%
     expandLimits(pts$lat, pts$lng)
 }
 
@@ -891,6 +912,7 @@ addCircles = function(
   fillOpacity = 0.2,
   dashArray = NULL,
   popup = NULL,
+  popupOptions = NULL,
   label = NULL,
   labelOptions = NULL,
   options = pathOptions(),
@@ -902,7 +924,8 @@ addCircles = function(
     dashArray = dashArray
   ))
   pts = derivePoints(data, lng, lat, missing(lng), missing(lat), "addCircles")
-  invokeMethod(map, data, 'addCircles', pts$lat, pts$lng, radius, layerId, group, options, popup, safeLabel(label, data), labelOptions) %>%
+  invokeMethod(map, data, 'addCircles', pts$lat, pts$lng, radius, layerId, group, options,
+               popup, popupOptions, safeLabel(label, data), labelOptions) %>%
     expandLimits(pts$lat, pts$lng)
 }
 
@@ -924,6 +947,7 @@ addPolylines = function(
   smoothFactor = 1.0,
   noClip = FALSE,
   popup = NULL,
+  popupOptions = NULL,
   label = NULL,
   labelOptions = NULL,
   options = pathOptions(),
@@ -935,7 +959,8 @@ addPolylines = function(
     dashArray = dashArray, smoothFactor = smoothFactor, noClip = noClip
   ))
   pgons = derivePolygons(data, lng, lat, missing(lng), missing(lat), "addPolylines")
-  invokeMethod(map, data, 'addPolylines', pgons, layerId, group, options, popup, safeLabel(label, data), labelOptions) %>%
+  invokeMethod(map, data, 'addPolylines', pgons, layerId, group, options,
+               popup, popupOptions, safeLabel(label, data), labelOptions) %>%
     expandLimitsBbox(pgons)
 }
 
@@ -956,6 +981,7 @@ addRectangles = function(
   smoothFactor = 1.0,
   noClip = FALSE,
   popup = NULL,
+  popupOptions = NULL,
   label = NULL,
   labelOptions = NULL,
   options = pathOptions(),
@@ -970,7 +996,7 @@ addRectangles = function(
   lat1 = resolveFormula(lat1, data)
   lng2 = resolveFormula(lng2, data)
   lat2 = resolveFormula(lat2, data)
-  invokeMethod(map, data, 'addRectangles',lat1, lng1, lat2, lng2, layerId, group, options, popup, safeLabel(label, data), labelOptions) %>%
+  invokeMethod(map, data, 'addRectangles',lat1, lng1, lat2, lng2, layerId, group, options, popup, popupOptions, safeLabel(label, data), labelOptions) %>%
     expandLimits(c(lat1, lat2), c(lng1, lng2))
 }
 
@@ -989,6 +1015,7 @@ addPolygons = function(
   smoothFactor = 1.0,
   noClip = FALSE,
   popup = NULL,
+  popupOptions = NULL,
   label = NULL,
   labelOptions = NULL,
   options = pathOptions(),
@@ -1000,7 +1027,7 @@ addPolygons = function(
     dashArray = dashArray, smoothFactor = smoothFactor, noClip = noClip
   ))
   pgons = derivePolygons(data, lng, lat, missing(lng), missing(lat), "addPolygons")
-  invokeMethod(map, data, 'addPolygons', pgons, layerId, group, options, popup, safeLabel(label, data), labelOptions) %>%
+  invokeMethod(map, data, 'addPolygons', pgons, layerId, group, options, popup, popupOptions, safeLabel(label, data), labelOptions) %>%
     expandLimitsBbox(pgons)
 }
 

R/normalize.R

@@ -50,9 +50,16 @@ doResolveFormula.SpatialPointsDataFrame = function(data, f) {
   doResolveFormula(data@data, f)
 }
 
-# Given a data object and lng/lat arguments (which may be NULL [meaning infer
-# from data], formula [which should be evaluated with respect to the data], or
-# vector data [which should be used as-is]) return a lng/lat data frame.
+#' Given a data object and lng/lat arguments (which may be NULL [meaning infer
+#' from data], formula [which should be evaluated with respect to the data], or
+#' vector data [which should be used as-is]) return a lng/lat data frame.
+#' @param data map data
+#' @param lng longitude
+#' @param lat latitude
+#' @param missingLng whether lng is missing
+#' @param missingLat whether lat is missing
+#' @param funcName Name of calling function (for logging)
+#' @export
 derivePoints = function(data, lng, lat, missingLng, missingLat, funcName) {
   if (missingLng || missingLat) {
     if (is.null(data)) {
@@ -78,6 +85,16 @@ derivePoints = function(data, lng, lat, missingLng, missingLat, funcName) {
   data.frame(lng = lng, lat = lat)
 }
 
+#' Given a data object and lng/lat arguments (which may be NULL [meaning infer
+#' from data], formula [which should be evaluated with respect to the data], or
+#' vector data [which should be used as-is]) return a spatial object
+#' @param data map data
+#' @param lng longitude
+#' @param lat latitude
+#' @param missingLng whether lng is missing
+#' @param missingLat whether lat is missing
+#' @param funcName Name of calling function (for logging)
+#' @export
 derivePolygons = function(data, lng, lat, missingLng, missingLat, funcName) {
   if (missingLng != missingLat) {
     stop(funcName, " must be called with both lng and lat, or with neither.")

R/plugin-awesomeMarkers.R

@@ -207,6 +207,7 @@ verifyIconLibrary <- function(library) {
 #'   the latitude column from \code{data})
 #' @param popup a character vector of the HTML content for the popups (you are
 #'   recommended to escape the text using \code{\link[htmltools]{htmlEscape}()}
+#' @param popupOptions A Vector of \code{\link{popupOptions}} to provide popups
 #'   for security reasons)
 #' @param layerId the layer id
 #' @param group the name of the group the newly created layers should belong to
@@ -233,6 +234,7 @@ addAwesomeMarkers = function(
   map, lng = NULL, lat = NULL, layerId = NULL, group = NULL,
   icon = NULL,
   popup = NULL,
+  popupOptions = NULL,
   label = NULL,
   labelOptions = NULL,
   options = markerOptions(),
@@ -270,7 +272,8 @@ addAwesomeMarkers = function(
 
   pts = derivePoints(data, lng, lat, missing(lng), missing(lat), "addAwesomeMarkers")
   invokeMethod(
-    map, data, 'addAwesomeMarkers', pts$lat, pts$lng, icon, layerId, group, options, popup,
+    map, data, 'addAwesomeMarkers', pts$lat, pts$lng, icon, layerId,
+    group, options, popup, popupOptions,
     clusterOptions, clusterId, safeLabel(label, data), labelOptions
   ) %>% expandLimits(pts$lat, pts$lng)
 }

R/utils.R

@@ -31,7 +31,9 @@ dispatch = function(map,
     stop("Invalid map parameter")
 }
 
-# remove NULL elements from a list
+#' remove NULL elements from a list
+#' @param x A list whose NULL elements will be filtered
+#' @export
 filterNULL = function(x) {
   if (length(x) == 0 || !is.list(x)) return(x)
   x[!unlist(lapply(x, is.null))]