Lintr (#1)

* ignore revdep, scripts, and viztest

* add barret as ctb and remotes

* white space

* add revdep script

* lintr init

* spaces_left_parentheses_linter, multiple_dots_linter, assignment_linter, trailing_blank_lines_linter

* no_tab_linter

* commas_linter

* infix_spaces_linter

* single_quotes_linter

.Rbuildignore

@@ -15,3 +15,6 @@
 ^\_pkgdown\.yaml$
 ^CONDUCT\.md$
 ^\.Rprofile\.local$
+^scripts
+^revdep
+^viztest

.gitignore

@@ -25,3 +25,4 @@ vignettes/*.pdf
 .Rproj.user
 .Rprofile.local
 docs
+viztest*

.lintr

@@ -0,0 +1,6 @@
+linters: with_defaults(
+    camel_case_linter = NULL, # 122
+    line_length_linter = NULL, # 33
+    commented_code_linter = NULL, # 3
+    NULL
+  )

DESCRIPTION

@@ -2,14 +2,19 @@ Package: leaflet.esri
 Type: Package
 Title: 'ESRI' Bindings for the 'leaflet' Package
 Version: 0.2.9000
-Authors@R: person("Bhaskar", "Karambelkar", email = "[email protected]",
-    role = c("aut", "cre"))
+Authors@R: c(
+      person("Bhaskar", "Karambelkar", email = "[email protected]", role = c("aut", "cre")),
+      person("Barret", "Schloerke", email = "[email protected]", role = c("ctb"))
+    )
 Description: An add-on package to the 'leaflet' package, which provides bindings for 'ESRI' services. This package allows a user to add 'ESRI' provided services such as 'MapService', 'ImageMapService', 'TiledMapService' etc. to a 'leaflet' map.
 License: GPL-3 | file LICENSE
 Depends:
     R (>= 3.1.0),
-    leaflet (>= 1.1.0),
-    leaflet.extras (>= 0.2)
+    leaflet (>= 2.0.0),
+    leaflet.extras (> 0.2.0)
+Remotes:
+    schloerke/leaflet@barret/v1x,
+    schloerke/leaflet.extras@v1x
 Encoding: UTF-8
 LazyData: true
 Imports:

R/basemapLayers.R

@@ -4,28 +4,28 @@
 #' Taken from \url{https://esri.github.io/esri-leaflet/api-reference/layers/basemap-layer.html}.
 #' @export
 esriBasemapLayers <- list(
-  'Streets' = 'Streets',
-  'Topographic' = 'Topographic',
-  'NationalGeographic' = 'NationalGeographic',
-  'Oceans' = 'Oceans',
-  'Gray' = 'Gray',
-  'DarkGray' = 'DarkGray',
-  'Imagery' = 'Imagery',
-  'ShadedRelief' = 'ShadedRelief',
-  'Terrain' = 'Terrain')
+  "Streets" = "Streets",
+  "Topographic" = "Topographic",
+  "NationalGeographic" = "NationalGeographic",
+  "Oceans" = "Oceans",
+  "Gray" = "Gray",
+  "DarkGray" = "DarkGray",
+  "Imagery" = "Imagery",
+  "ShadedRelief" = "ShadedRelief",
+  "Terrain" = "Terrain")
 
 #' Esri basemap labels.
 #'
 #' Taken from \url{https://esri.github.io/esri-leaflet/api-reference/layers/basemap-layer.html#optional-labels}.
 #' @export
 esriBasemapLabels <- list(
-  'OceansLabels' = 'OceansLabels',
-  'GrayLabels' = 'GrayLabels',
-  'DarkGrayLabels' = 'DarkGrayLabels',
-  'ImageryLabels' = 'ImageryLabels',
-  'ImageryTransportation' = 'ImageryTransportation',
-  'ShadedReliefLabels' = 'ShadedReliefLabels',
-  'TerrainLabels' = 'TerrainLabels'
+  "OceansLabels" = "OceansLabels",
+  "GrayLabels" = "GrayLabels",
+  "DarkGrayLabels" = "DarkGrayLabels",
+  "ImageryLabels" = "ImageryLabels",
+  "ImageryTransportation" = "ImageryTransportation",
+  "ShadedReliefLabels" = "ShadedReliefLabels",
+  "TerrainLabels" = "TerrainLabels"
 )
 
 #' Adds a ArcGIS Basemap layer
@@ -37,7 +37,7 @@ esriBasemapLabels <- list(
 #' @param options Basemap Layer Options. You can pass \code{\link[leaflet]{tileOptions}()}.
 #' @examples \dontrun{
 #' leaflet() %>%
-#'    addEsriBasemapLayer(esriBasemapLayers$Oceans, autoLabels=TRUE)
+#'    addEsriBasemapLayer(esriBasemapLayers$Oceans, autoLabels = TRUE)
 #' }
 #' @export
 addEsriBasemapLayer <- function(
@@ -47,21 +47,21 @@ addEsriBasemapLayer <- function(
 
   map <- addEsriDependency(map)
 
-  if(is.null(options)) {
+  if (is.null(options)) {
     options <- list()
   }
 
-  if(!(key %in% esriBasemapLayers || key %in% esriBasemapLabels)) {
+  if (!(key %in% esriBasemapLayers || key %in% esriBasemapLabels)) {
     stop("Invalid Basemap layer Key")
   }
 
   labelLayer <- NULL
-  if(autoLabels) {
-    labelLayer <- esriBasemapLabels[[sprintf("%sLabels",key)]]
+  if (autoLabels) {
+    labelLayer <- esriBasemapLabels[[sprintf("%sLabels", key)]]
   }
 
   leaflet::invokeMethod(
     map, leaflet::getMapData(map),
-    'addEsriBasemapLayer', key, labelLayer, layerId, group, options)
+    "addEsriBasemapLayer", key, labelLayer, layerId, group, options)
 
 }

R/dynamicMapLayers.R

@@ -1,53 +1,53 @@
 #' Options for dynamic map layer.
 #'
-#' @param format	Output format of the image.
-#' @param transparent	Allow the server to produce transparent images.
-#' @param f	Server response content type.
-#' @param attribution	Attribution from service metadata copyright text is automatically displayed in Leaflet's default control. This property can be used for customization.
-#' @param layers	An array of Layer IDs like [3,4,5] to show from the service.
-#' @param layerDefs	A string representing a query to run against the service before the image is rendered. This can be a string like "3:STATE_NAME='Kansas'" or an object mapping different queries to specific layers {3:"STATE_NAME='Kansas'", 2:"POP2007>25000"}.
-#' @param opacity	Opacity of the layer. Should be a value between 0 (completely transparent) and 1 (completely opaque).
-#' @param position	Position of the layer relative to other overlays.
-#' @param maxZoom	Closest zoom level the layer will be displayed on the map.
-#' @param minZoom	Furthest zoom level the layer will be displayed on the map.
-#' @param dynamicLayers	JSON object literal used to manipulate the layer symbology defined in the service itself. Requires a 10.1 (or above) map service which supports dynamicLayers requests.
-#' @param token	If you pass a token in your options it will be included in all requests to the service.
-#' @param proxy	URL of an \href{https://developers.arcgis.com/javascript/jshelp/ags_proxy.html}{ArcGIS API for JavaScript proxy} or \href{https://github.com/Esri/resource-proxy}{ArcGIS Resource Proxy} to use for proxying requests.
-#' @param useCors	If this service should use CORS when making GET requests.
+#' @param format Output format of the image.
+#' @param transparent Allow the server to produce transparent images.
+#' @param f Server response content type.
+#' @param attribution Attribution from service metadata copyright text is automatically displayed in Leaflet's default control. This property can be used for customization.
+#' @param layers An array of Layer IDs like [3, 4, 5] to show from the service.
+#' @param layerDefs A string representing a query to run against the service before the image is rendered. This can be a string like "3:STATE_NAME="Kansas"" or an object mapping different queries to specific layers {3:"STATE_NAME="Kansas"", 2:"POP2007>25000"}.
+#' @param opacity Opacity of the layer. Should be a value between 0 (completely transparent) and 1 (completely opaque).
+#' @param position Position of the layer relative to other overlays.
+#' @param maxZoom Closest zoom level the layer will be displayed on the map.
+#' @param minZoom Furthest zoom level the layer will be displayed on the map.
+#' @param dynamicLayers JSON object literal used to manipulate the layer symbology defined in the service itself. Requires a 10.1 (or above) map service which supports dynamicLayers requests.
+#' @param token If you pass a token in your options it will be included in all requests to the service.
+#' @param proxy URL of an \href{https://developers.arcgis.com/javascript/jshelp/ags_proxy.html}{ArcGIS API for JavaScript proxy} or \href{https://github.com/Esri/resource-proxy}{ArcGIS Resource Proxy} to use for proxying requests.
+#' @param useCors If this service should use CORS when making GET requests.
 #' @param ... extra options
 #' @export
 dynamicMapLayerOptions <- function(
-  format =	'png24',
+  format = "png24",
   transparent = TRUE,
-  f = 'json',
-  attribution = '',
-  layers	= NULL,
+  f = "json",
+  attribution = "",
+  layers = NULL,
   layerDefs = NULL,
   opacity = 1,
-  position = 'front',
+  position = "front",
   maxZoom = NULL,
   minZoom = NULL,
   dynamicLayers = NULL,
-  token	 = NULL,
-  proxy	 = NULL,
-  useCors	 = TRUE,
+  token = NULL,
+  proxy = NULL,
+  useCors = TRUE,
   ...
 ) {
   leaflet::filterNULL(list(
-    format =	format,
+    format = format,
     transparent = transparent,
     f = f,
     attribution = attribution,
-    layers	= layers,
+    layers = layers,
     layerDefs = layerDefs,
     opacity = opacity,
     position = position,
     maxZoom = maxZoom,
     minZoom = minZoom,
     dynamicLayers = dynamicLayers,
-    token	 = token,
-    proxy	 = proxy,
-    useCors	 = useCors,
+    token = token,
+    proxy = proxy,
+    useCors = useCors,
     ...
 
   ))
@@ -77,11 +77,11 @@ addEsriDynamicMapLayer <- function(
   popupFunction = NULL, popupOptions = NULL,
   layerId = NULL, group = NULL) {
   map <- addEsriDependency(map)
-  if(is.null(options)) {
+  if (is.null(options)) {
     options <- list()
   }
   leaflet::invokeMethod(
     map, leaflet::getMapData(map),
-    'addEsriDynamicMapLayer', url, layerId, group,
+    "addEsriDynamicMapLayer", url, layerId, group,
     options, popupFunction, popupOptions)
 }

R/featureLayers.R

@@ -1,30 +1,30 @@
 #' Options for featureLayers.
 #'
-#' @param where	String	An optional expression to filter features server side.
-#'  String values should be denoted using single quotes ie: where: "FIELDNAME = 'field value'"; More information about valid SQL syntax can be found at \url{http://resources.arcgis.com/en/help/main/10.2/index.html#/SQL_reference_for_query_expressions_used_in_ArcGIS/00s500000033000000/}.
-#' @param minZoom	Integer	Minimum zoom level of the map that features will display.
+#' @param where String An optional expression to filter features server side.
+#'  String values should be denoted using single quotes ie: where: "FIELDNAME = "field value""; More information about valid SQL syntax can be found at \url{http://resources.arcgis.com/en/help/main/10.2/index.html#/SQL_reference_for_query_expressions_used_in_ArcGIS/00s500000033000000/}.
+#' @param minZoom Integer Minimum zoom level of the map that features will display.
 #' example: minZoom:0
-#' @param maxZoom	Integer	Maximum zoom level of the map that features will
+#' @param maxZoom Integer Maximum zoom level of the map that features will
 #' example: maxZoom:19
-#' @param cacheLayers	Boolean	Will remove layers from the internal cache when they are removed from the map.
-#' @param fields	Array	An array of fieldnames to pull from the service.
-#' Includes all fields by default. You should always specify the name of the unique id for the service. Usually either 'FID' or 'OBJECTID'.
-#' @param from	Date	When paired with to defines the time range of features to display.
+#' @param cacheLayers Boolean Will remove layers from the internal cache when they are removed from the map.
+#' @param fields Array An array of fieldnames to pull from the service.
+#' Includes all fields by default. You should always specify the name of the unique id for the service. Usually either "FID" or "OBJECTID".
+#' @param from Date When paired with to defines the time range of features to display.
 #' Requires the Feature Layer to be time enabled.
-#' @param to	Date	When paired with from defines the time range of features to display.
+#' @param to Date When paired with from defines the time range of features to display.
 #' Requires the Feature Layer to be time enabled.
-#' @param timeField	false	The name of the field to lookup the time of the feature.
-#' Can be an object like {start:'startTime', end:'endTime'} or a string like 'created'.
-#' @param timeFilterMode	'server' (default) or 'client'	Determines where features are filtered by time.
-#' By default features will be filtered by the server. If set to 'client' all features are requested and filtered by the app before display.
-#' @param simplifyFactor	Integer	How much to simplify polygons and polylines.
+#' @param timeField false The name of the field to lookup the time of the feature.
+#' Can be an object like {start:"startTime", end:"endTime"} or a string like "created".
+#' @param timeFilterMode "server" (default) or "client" Determines where features are filtered by time.
+#' By default features will be filtered by the server. If set to "client" all features are requested and filtered by the app before display.
+#' @param simplifyFactor Integer How much to simplify polygons and polylines.
 #' More means better performance, and less means more accurate representation.
-#' @param precision	Integer	How many digits of precision to request from the server.
+#' @param precision Integer How many digits of precision to request from the server.
 #' Wikipedia has a great reference of digit precision to meters at \url{http://en.wikipedia.org/wiki/Decimal_degrees}.
-#' @param token	String	If you pass a token in your options it will be included in all requests to the service.
-#' @param proxy	URL of an \href{https://developers.arcgis.com/javascript/jshelp/ags_proxy.html}{ArcGIS API for JavaScript proxy} or \href{https://github.com/Esri/resource-proxy}{ArcGIS Resource Proxy} to use for proxying requests.
-#' @param useCors	Boolean	If this service should use CORS when making GET requests.
-#' @param renderer	L.svg or L.canvas	The vector renderer to use to draw the service.
+#' @param token String If you pass a token in your options it will be included in all requests to the service.
+#' @param proxy URL of an \href{https://developers.arcgis.com/javascript/jshelp/ags_proxy.html}{ArcGIS API for JavaScript proxy} or \href{https://github.com/Esri/resource-proxy}{ArcGIS Resource Proxy} to use for proxying requests.
+#' @param useCors Boolean If this service should use CORS when making GET requests.
+#' @param renderer L.svg or L.canvas The vector renderer to use to draw the service.
 #' Usually L.svg but setting to L.canvas contains performance benefits for large polygon layers.
 #' @param ... extra options
 #' @export
@@ -78,7 +78,7 @@ featureLayerOptions <- function(
 #' @param layerId A unique ID for the layer.
 #' @param group The name of the group this layer should be added to.
 #'   the same parameter under \code{\link{addTiles}})
-#' @param markerType The type of marker.  either 'marker' or 'circleMarker'
+#' @param markerType The type of marker.  either "marker" or "circleMarker"
 #' @param markerIcons Icons for Marker.
 #' @param markerIconProperty The property of the feature to use for marker icon.
 #' Can be a JS function which accepts a feature and returns an index of \code{markerIcons}.
@@ -146,7 +146,7 @@ addEsriFeatureLayer <- function(
   map$dependencies <- c(map$dependencies,
                         leaflet.extras::leafletExtrasDependencies$omnivore())
 
-  if(useServiceSymbology) {
+  if (useServiceSymbology) {
     map <- addEsriRenderersDependency(map)
   } else {
     map <- addEsriDependency(map)
@@ -157,33 +157,33 @@ addEsriFeatureLayer <- function(
     map <- addEsriClusterDependency(map)
   }
 
-  pathOptions = c(pathOptions, list(
+  pathOptions <- c(pathOptions, list(
     stroke = stroke, color = color, weight = weight, opacity = opacity,
     fill = fill, fillColor = fillColor, fillOpacity = fillOpacity,
     dashArray = dashArray, smoothFactor = smoothFactor, noClip = noClip))
 
   markerIconFunction <- NULL
-  if(!is.null(markerIcons)) {
-    if(inherits(markerIcons,'leaflet_icon_set') ||
-       inherits(markerIcons, 'leaflet_icon')) {
+  if (!is.null(markerIcons)) {
+    if (inherits(markerIcons, "leaflet_icon_set") ||
+       inherits(markerIcons, "leaflet_icon")) {
       markerIconFunction <- defIconFunction
-    } else if(inherits(markerIcons,'leaflet_awesome_icon_set') ||
-              inherits(markerIcons, 'leaflet_awesome_icon')) {
-      if(inherits(markerIcons,'leaflet_awesome_icon_set')) {
-        libs <- unique(sapply(markerIcons,function(icon) icon$library))
-        map <- leaflet.extras::addAwesomeMarkersDependencies(map,libs)
+    } else if (inherits(markerIcons, "leaflet_awesome_icon_set") ||
+              inherits(markerIcons, "leaflet_awesome_icon")) {
+      if (inherits(markerIcons, "leaflet_awesome_icon_set")) {
+        libs <- unique(sapply(markerIcons, function(icon) icon$library))
+        map <- leaflet.extras::addAwesomeMarkersDependencies(map, libs)
       } else {
         map <- leaflet.extras::addAwesomeMarkersDependencies(
-          map,markerIcons$library)
+          map, markerIcons$library)
       }
       markerIconFunction <- awesomeIconFunction
     } else {
-      stop('markerIcons should be created using either leaflet::iconList() or leaflet::awesomeIconList()')
+      stop("markerIcons should be created using either leaflet::iconList() or leaflet::awesomeIconList()")
     }
   }
 
   leaflet::invokeMethod(
-    map, leaflet::getMapData(map), 'addEsriFeatureLayer', url, options, layerId, group,
+    map, leaflet::getMapData(map), "addEsriFeatureLayer", url, options, layerId, group,
     markerType, markerIcons,
     markerIconProperty, markerOptions, markerIconFunction,
     clusterOptions, clusterId,
@@ -217,5 +217,5 @@ addEsriHeatmapFeatureLayer <- function(
   )))
   leaflet::invokeMethod(
     map, leaflet::getMapData(map),
-    'addEsriHeatmapFeatureLayer', url, layerId, group, options)
+    "addEsriHeatmapFeatureLayer", url, layerId, group, options)
 }

R/htmlDependencies.R

@@ -1,7 +1,7 @@
 esriDependency <- function() {
   list(
     htmltools::htmlDependency(
-      "esri.leaflet",version = "1.0.4",
+      "esri.leaflet", version = "1.0.4",
       system.file("htmlwidgets/lib/esri", package = "leaflet.esri"),
       script = c("esri-leaflet.js", "esri-leaflet-bindings.js")
     )
@@ -20,7 +20,7 @@ addEsriDependency <- function(map) {
 esriClusterDependency <- function() {
   list(
     htmltools::htmlDependency(
-      "esri.leaflet.cluster",version = "1.0.2",
+      "esri.leaflet.cluster", version = "1.0.2",
       system.file("htmlwidgets/lib/esri-cluster", package = "leaflet.esri"),
       script = c("esri-leaflet-clustered-feature-layer-src.js")
     )
@@ -41,7 +41,7 @@ addEsriClusterDependency <- function(map) {
 esriGeocoderDependency <- function() {
   list(
     htmltools::htmlDependency(
-      "esri.leaflet.geocoder",version = "1.0.2",
+      "esri.leaflet.geocoder", version = "1.0.2",
       system.file("htmlwidgets/lib/esri-geocoder", package = "leaflet.esri"),
       script = c("esri-leaflet-geocoder.js"),
       stylesheet = c("esri-leaflet-geocoder.css")
@@ -62,7 +62,7 @@ addEsriGeocoderDependency <- function(map) {
 esriHeatmapDependency <- function() {
   list(
     htmltools::htmlDependency(
-      "esri.leaflet.heatmap",version = "1.0.2",
+      "esri.leaflet.heatmap", version = "1.0.2",
       system.file("htmlwidgets/lib/esri-heatmap", package = "leaflet.esri"),
       script = c("leaflet-heat.js",
                  "esri-leaflet-heatmap-feature-layer.js")
@@ -83,7 +83,7 @@ addEsriHeatmapDependency <- function(map) {
 esriRenderersDependency <- function() {
   list(
     htmltools::htmlDependency(
-      "esri.leaflet.renderers",version = "1.0.2",
+      "esri.leaflet.renderers", version = "1.0.2",
       system.file("htmlwidgets/lib/esri-renderers", package = "leaflet.esri"),
       script = c("esri-leaflet-renderers.js")
     )