Exported some useful functions for use in external packages

Author: bhaskarvk

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)

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")
@@ -423,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)
@@ -553,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(

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/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))]