Convert documentation to Markdown with roxygen2md

DESCRIPTION

@@ -24,4 +24,5 @@ Suggests:
     htmlwidgets
 URL: https://github.com/bhaskarvk/leaflet.esri,https://bhaskarvk.github.io/leaflet.esri/
 BugReports: https://github.com/bhaskarvk/leaflet.esri/issues
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.1
+Roxygen: list(markdown = TRUE)

R/basemapLayers.R

@@ -1,7 +1,7 @@
 #' Esri Basemap Layers.
 #'
 #' BasemapLayer is used to display Esri hosted basemaps and attributes data providers appropriately. The Terms of Use for Esri hosted services apply to all Leaflet applications.
-#' Taken from \url{https://esri.github.io/esri-leaflet/api-reference/layers/basemap-layer.html}.
+#' Taken from <https://esri.github.io/esri-leaflet/api-reference/layers/basemap-layer.html>.
 #' @export
 esriBasemapLayers <- list(
   "Streets" = "Streets",
@@ -16,7 +16,7 @@ esriBasemapLayers <- list(
 
 #' Esri basemap labels.
 #'
-#' Taken from \url{https://esri.github.io/esri-leaflet/api-reference/layers/basemap-layer.html#optional-labels}.
+#' Taken from <https://esri.github.io/esri-leaflet/api-reference/layers/basemap-layer.html#optional-labels>.
 #' @export
 esriBasemapLabels <- list(
   "OceansLabels" = "OceansLabels",
@@ -34,7 +34,7 @@ esriBasemapLabels <- list(
 #' @param autoLabels whether to show corresponding labels layer
 #' @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}()}.
+#' @param options Basemap Layer Options. You can pass [leaflet::tileOptions()].
 #' @examples
 #' leaflet() %>%
 #'    addEsriBasemapLayer(esriBasemapLayers$Oceans, autoLabels = TRUE)

R/dynamicMapLayers.R

@@ -4,15 +4,15 @@
 #' @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 layers An array of Layer IDs like `JS("[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 proxy URL of an [ArcGIS API for JavaScript proxy](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resource Proxy](https://github.com/Esri/resource-proxy) to use for proxying requests.
 #' @param useCors If this service should use CORS when making GET requests.
 #' @param ... extra options
 #' @export
@@ -60,14 +60,14 @@ dynamicMapLayerOptions <- function(
 #' identifying features and more.
 #' Also supports custom popups and identification of features.
 #' @param map The leaflet map
-#' @param url URL of the \href{http://resources.arcgis.com/en/help/arcgis-rest-api/#/Map_Service/02r3000000w2000000/}{Map Service}.
+#' @param url URL of the [Map Service](http://resources.arcgis.com/en/help/arcgis-rest-api/#/Map_Service/02r3000000w2000000/).
 #' @param options options for the dynamic map layer.
 #' @param popupFunction Uses the provided function to create a popup that will
 #'   identify features whenever the map is clicked.
 #'   Your function will be passed a GeoJSON FeatureCollection of the features
 #'    at the clicked location and should return the appropriate HTML.
 #'    If you do not want to open the popup when there are no results, return false.
-#' @param popupOptions See \code{\link[leaflet]{popupOptions}}.
+#' @param popupOptions See [leaflet::popupOptions()].
 #' @param layerId A unique ID for the layer.
 #' @param group The name of the group this layer should be added to.
 #' @export

R/featureLayers.R

@@ -1,7 +1,7 @@
 #' 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/}.
+#'  String values should be denoted using single quotes ie: where: "FIELDNAME = "field value""; More information about valid SQL syntax can be found at <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
@@ -20,9 +20,9 @@
 #' @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.
-#' Wikipedia has a great reference of digit precision to meters at \url{http://en.wikipedia.org/wiki/Decimal_degrees}.
+#' Wikipedia has a great reference of digit precision to meters at <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 proxy URL of an [ArcGIS API for JavaScript proxy](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resource Proxy](https://github.com/Esri/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.
@@ -72,32 +72,32 @@ featureLayerOptions <- function(
 #'
 #' FeatureLayer is used to visualize, style, query and edit vector geographic data hosted in both ArcGIS Online and published using ArcGIS Server. Copyright text from the service is added to map attribution automatically.
 #' @param map The leaflet map
-#' @param url url of the \href{http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Feature_Service/02r3000000z2000000/}{FeatureService} or \href{http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Map_Service/02r3000000w2000000/}{MapService}.
+#' @param url url of the [FeatureService](http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Feature_Service/02r3000000z2000000/) or [MapService](http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Map_Service/02r3000000w2000000/).
 #' @param useServiceSymbology whether to use the symbology set when a service was published.
 #' @param options options for the featurelayer
 #' @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}})
+#'   the same parameter under [addTiles()])
 #' @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}.
+#' Can be a JS function which accepts a feature and returns an index of `markerIcons`.
 #' In either case the result must be one of the indexes of markerIcons.
 #' @param markerOptions The options for markers
-#' Can be a single marker using \code{\link[leaflet]{makeIcon}}
-#' or a list of markers using \code{\link[leaflet]{iconList}}
-#' @param clusterOptions if not \code{NULL}, markers will be clustered using
-#'   \href{https://github.com/Leaflet/Leaflet.markercluster}{Leaflet.markercluster};
-#'    you can use \code{\link[leaflet]{markerClusterOptions}()} to specify marker cluster
+#' Can be a single marker using [leaflet::makeIcon()]
+#' or a list of markers using [leaflet::iconList()]
+#' @param clusterOptions if not `NULL`, markers will be clustered using
+#'   [Leaflet.markercluster](https://github.com/Leaflet/Leaflet.markercluster);
+#'    you can use [leaflet::markerClusterOptions()] to specify marker cluster
 #'   options
 #' @param clusterId the id for the marker cluster layer
 #' @param labelProperty The property to use for the label.
 #' You can also pass in a JS function that takes in a feature and returns a text/HTML content.
-#' @param labelOptions A Vector of \code{\link{labelOptions}} to provide label
-#' options for each label. Default \code{NULL}
+#' @param labelOptions A Vector of [labelOptions()] to provide label
+#' options for each label. Default `NULL`
 #' @param popupProperty The property to use for popup content
 #' You can also pass in a JS function that takes in a feature and returns a text/HTML content.
-#' @param popupOptions A Vector of \code{\link{popupOptions}} to provide popups
+#' @param popupOptions A Vector of [popupOptions()] to provide popups
 #' @param stroke whether to draw stroke along the path (e.g. the borders of
 #'   polygons or circles)
 #' @param color stroke color
@@ -108,14 +108,14 @@ featureLayerOptions <- function(
 #' @param fillColor fill color
 #' @param fillOpacity fill opacity
 #' @param dashArray a string that defines the stroke
-#'   \href{https://developer.mozilla.org/en/SVG/Attribute/stroke-dasharray}{dash
-#'   pattern}
+#'   [dash
+#'   pattern](https://developer.mozilla.org/en/SVG/Attribute/stroke-dasharray)
 #' @param smoothFactor how much to simplify the polyline on each zoom level
 #'   (more means better performance and less accurate representation)
 #' @param noClip whether to disable polyline clipping
 #' @param pathOptions Options for shapes
 #' @param highlightOptions Options for highlighting the shape on mouse over.
-#'    you can use \code{\link[leaflet]{highlightOptions}()} to specify highlight
+#'    you can use [leaflet::highlightOptions()] to specify highlight
 #' @param fitBounds Whether to set the maps bounds to fit the data in the featureLayer
 #'   options
 #' @export
@@ -217,11 +217,11 @@ addEsriFeatureLayer <- function(
 #' Add Esri Heatmap Feature Layer.
 #'
 #' @param map The leaflet map
-#' @param url url of the \href{http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Feature_Service/02r3000000z2000000/}{FeatureService} or \href{http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Map_Service/02r3000000w2000000/}{MapService}.
+#' @param url url of the [FeatureService](http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Feature_Service/02r3000000z2000000/) or [MapService](http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Map_Service/02r3000000w2000000/).
 #' @param options options for the featurelayer
 #' @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}})
+#'   the same parameter under [addTiles()])
 #' @param radius Radius for the heatmap
 #' @param gradient The gradient
 #' @export

R/imageMapLayers.R

@@ -16,10 +16,10 @@
 #' @param pixelType Leave pixelType as unspecified, or UNKNOWN, in most exportImage use cases,
 #'   unless such pixelType is desired.
 #'   Possible values: C128, C64, F32, F64, S16, S32, S8, U1, U16, U2, U32, U4, U8, UNKNOWN.
-#' @param renderingRule A JSON representation of a \href{http://resources.arcgis.com/en/help/arcgis-rest-api/#/Raster_function_objects/02r3000000rv000000/}{raster function}
-#' @param mosaicRule A JSON representation of a \href{http://resources.arcgis.com/en/help/arcgis-rest-api/#/Mosaic_rule_objects/02r3000000s4000000/}{mosaic rule}
+#' @param renderingRule A JSON representation of a [raster function](http://resources.arcgis.com/en/help/arcgis-rest-api/#/Raster_function_objects/02r3000000rv000000/)
+#' @param mosaicRule A JSON representation of a [mosaic rule](http://resources.arcgis.com/en/help/arcgis-rest-api/#/Mosaic_rule_objects/02r3000000s4000000/)
 #' @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 proxy URL of an [ArcGIS API for JavaScript proxy](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resource Proxy](https://github.com/Esri/resource-proxy) to use for proxying requests.
 #' @param useCors If this service should use CORS when making GET requests.
 #' @param ... extra options
 #' @export
@@ -69,14 +69,14 @@ imageMapLayerOptions <- function(
 #'
 #' Image Services provide access to raster data through a web service.
 #' @param map The leaflet map
-#' @param url URL of the \href{http://resources.arcgis.com/en/help/arcgis-rest-api/#/Image_Service/02r3000000q8000000/}{Image Service}
+#' @param url URL of the [Image Service](http://resources.arcgis.com/en/help/arcgis-rest-api/#/Image_Service/02r3000000q8000000/)
 #' @param options options for the image map layer.
 #' @param popupFunction Uses the provided function to create a popup that will
 #'   identify features whenever the map is clicked.
 #'   Your function will be passed a GeoJSON FeatureCollection of the features
 #'    at the clicked location and should return the appropriate HTML.
 #'    If you do not want to open the popup when there are no results, return false.
-#' @param popupOptions See \code{\link[leaflet]{popupOptions}}.
+#' @param popupOptions See [leaflet::popupOptions()].
 #' @param layerId A unique ID for the layer.
 #' @param group The name of the group this layer should be added to.
 #' @export

R/tiledMapLayers.R

@@ -3,10 +3,10 @@
 #'
 #' @param correctZoomLevels Correct Zoom levels.
 #' @param zoomOffsetAllowance If correctZoomLevels is enabled this controls the amount of tolerance for the difference at each scale level for remapping tile levels.
-#' @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 proxy URL of an [ArcGIS API for JavaScript proxy](https://developers.arcgis.com/javascript/jshelp/ags_proxy.html) or [ArcGIS Resource Proxy](https://github.com/Esri/resource-proxy) to use for proxying requests.
 #' @param useCors Dictates if the service should use CORS when making GET requests.
 #' @param token Use this token to authenticate all calls to the service.
-#' @param tileOptions Other options for tile layer. You can pass \code{\link[leaflet]{tileOptions}()}.
+#' @param tileOptions Other options for tile layer. You can pass [leaflet::tileOptions()].
 #' @export
 tiledMapLayerOptions <- function(
   correctZoomLevels = TRUE,
@@ -27,10 +27,10 @@ tiledMapLayerOptions <- function(
 
 #' Access tiles from ArcGIS Online and ArcGIS Server to visualize and identify features.
 #'
-#' If you have published a Feature Service in ArcGIS Online, it can be used to create a static set of tiles as well. You can find details about that process in the \href{http://doc.arcgis.com/en/arcgis-online/share-maps/publish-tiles.htm#ESRI_SECTION1_F68FCBD33BD54117B23232D41A762E89}{ArcGIS Online Help}.
-#' Your map service must be published using the Web Mercator Auxiliary Sphere tiling scheme (WKID 102100/3857) and the default scale options used by Google Maps, Bing Maps and \href{http://resources.arcgis.com/en/help/arcgisonline-content/index.html#//011q00000002000000}{ArcGIS Online}. Esri Leaflet will not support any other spatial reference for tile layers.
+#' If you have published a Feature Service in ArcGIS Online, it can be used to create a static set of tiles as well. You can find details about that process in the [ArcGIS Online Help](http://doc.arcgis.com/en/arcgis-online/share-maps/publish-tiles.htm#ESRI_SECTION1_F68FCBD33BD54117B23232D41A762E89).
+#' Your map service must be published using the Web Mercator Auxiliary Sphere tiling scheme (WKID 102100/3857) and the default scale options used by Google Maps, Bing Maps and [ArcGIS Online](http://resources.arcgis.com/en/help/arcgisonline-content/index.html#//011q00000002000000). Esri Leaflet will not support any other spatial reference for tile layers.
 #' @param map The leaflet map
-#' @param url URL of the \href{http://resources.arcgis.com/en/help/arcgis-rest-api/#/Map_Service/02r3000000w2000000}{Map Service} with a tile cache.
+#' @param url URL of the [Map Service](http://resources.arcgis.com/en/help/arcgis-rest-api/#/Map_Service/02r3000000w2000000) with a tile cache.
 #' @param options options for the tiledmap layer.
 #' @param layerId A unique ID for the layer.
 #' @param group The name of the group this layer should be added to.