Skip to content

Commit 0336d6d

Browse files
committed
Add anchors to links
1 parent bbbadc7 commit 0336d6d

File tree

13 files changed

+119
-84
lines changed

13 files changed

+119
-84
lines changed

R/color.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
#' specified in at
77
#' @param at numeric vector giving the breakpoints for the colors
88
#' @param na.color the color for NA values.
9-
#' @param ... additional arguments passed on to \code{\link{level.colors}}
9+
#' @param ... additional arguments passed on to \code{\link[lattice]{level.colors}}
1010
#'
1111
#' @author
1212
#' Tim Appelhans
1313
#'
1414
#' @seealso
15-
#' \code{\link{level.colors}}
15+
#' \code{\link[lattice]{level.colors}}
1616
#'
1717
#' @name mapviewColors
1818
#' @export mapviewColors

R/extent.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
#' @param map a leaflet or mapview map the extent should be added to. If NULL
88
#' standard background layers are created.
99
#' @param popup a \code{list} of HTML strings with the popup contents, usually
10-
#' created from \code{\link{popupTable}}. See \code{\link{addControl}} for
10+
#' created from \code{\link[leafpop]{popupTable}}. See \code{\link[leaflet]{addControl}} for
1111
#' details.
1212
#' @param layer.name the name of the layer to be shown on the map.
1313
#' @param alpha.regions opacity of the fills or the raster layer(s).
1414
#' @param label a character vector of labels to be shown on mouseover. See
1515
#' \code{\link{addControl}} for details.
16-
#' @param ... additional arguments passed on to \code{\link{addRectangles}}
16+
#' @inheritDotParams leaflet::addRectangles
1717
#'
1818
#' @author
1919
#' Tim Appelhans

R/mapView.R

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ if ( !isGeneric('mapView') ) {
2929
#' @param map an optional existing map to be updated/added to.
3030
#' @param band for stars layers, the band number to be plotted.
3131
#' @param pane name of the map pane in which to render features. See
32-
#' \code{\link{addMapPane}} for details. Currently only supported for vector layers.
32+
#' \code{\link[leaflet]{addMapPane}} for details. Currently only supported for vector layers.
3333
#' Ignored if \code{canvas = TRUE}. The default \code{"auto"} will create different panes
3434
#' for points, lines and polygons such that points overlay lines overlay polygons.
3535
#' Set to \code{NULL} to get default leaflet behaviour where allfeatures
@@ -49,7 +49,7 @@ if ( !isGeneric('mapView') ) {
4949
#' See \code{\link{levelplot}} for details.
5050
#' @param na.color color for missing values
5151
#' @param use.layer.names should layer names of the Raster* object be used?
52-
#' @param map.types character spcifications for the base maps.
52+
#' @param map.types character specifications for the base maps.
5353
#' see \url{https://leaflet-extras.github.io/leaflet-providers/preview/}
5454
#' for available options.
5555
#' @param burst whether to show all (TRUE) or only one (FALSE) layer(s).
@@ -75,13 +75,13 @@ if ( !isGeneric('mapView') ) {
7575
#' Defaults to TRUE
7676
#' @param popup either \code{logical}, \code{character vector} or a \code{list}
7777
#' of HTML strings with the popup contents, usually created from
78-
#' \code{\link[leafpop]{popupTable}}. See \code{\link{addControl}} for details.
78+
#' \code{\link[leafpop]{popupTable}}. See \code{\link[leaflet]{addControl}} for details.
7979
#' If \code{FALSE} or \code{NULL} no popups will be created, if \code{TRUE}
8080
#' a table with all feature attributes/columns will be created.
8181
#' If a \code{character vector} of column names, the table will only show the
8282
#' respective column entries.
8383
#' @param label For vector data (sf/sp) a character vector of labels to be
84-
#' shown on mouseover. See \code{\link{addControl}} for details. For raster
84+
#' shown on mouseover. See \code{\link[leaflet]{addControl}} for details. For raster
8585
#' data (Raster*/stars) a logical indicating whether to add image query.
8686
#' @param native.crs logical whether to reproject to web map coordinate
8787
#' reference system (web mercator - epsg:3857) or render using native CRS of
@@ -98,7 +98,7 @@ if ( !isGeneric('mapView') ) {
9898
#' layer is of class \code{factor} in which case "ngb" is used.
9999
#' @param highlight either \code{FALSE}, \code{NULL} or a list of styling
100100
#' options for feature highlighting on mouse hover.
101-
#' See \code{\link{highlightOptions}} for details.
101+
#' See \code{\link[leaflet]{highlightOptions}} for details.
102102
#' @param maxpoints the maximum number of points making up the geometry.
103103
#' In case of lines and polygons this refers to the number of vertices. See
104104
#' Details for more information.
@@ -107,21 +107,21 @@ if ( !isGeneric('mapView') ) {
107107
#' @param query.digits for raster methods only. The amount of digits to be shown
108108
#' by raster value query. Ignored if \code{label = FALSE}.
109109
#' @param query.position for raster methods only. The position of the raster
110-
#' value query info box. See \code{position} argument of \code{\link{addLegend}}
110+
#' value query info box. See \code{position} argument of \code{\link[leaflet]{addLegend}}
111111
#' for possible values. Ignored if \code{label = FALSE}.
112112
#' @param query.prefix for raster methods only. a character string to be shown
113113
#' as prefix for the layerId. Ignored if \code{label = FALSE}.
114114
#' @param hide either a logical, a vector of layer names or a vector of layer indices.
115115
#' See Details for more information on what exactly it does for different raster types.
116116
#' @param ... additional arguments passed on to respective functions.
117-
#' See \code{\link{addRasterImage}}, \code{\link{addCircles}},
118-
#' \code{\link{addPolygons}}, \code{\link{addPolylines}} for details.
117+
#' See \code{\link[leaflet]{addRasterImage}}, \code{\link[leaflet]{addCircles}},
118+
#' \code{\link[leaflet]{addPolygons}}, \code{\link[leaflet]{addPolylines}} for details.
119119
#' Furthermore, you can pass hidden arguments to some methods. See Details for
120120
#' a list of supported hidden arguments.
121121
#'
122122
#' @details
123123
#' \code{maxpoints} is taken to determine when to switch rendering from svg
124-
#' to canvas overlay for perfomance. The threshold calculation is done as follows: \cr
124+
#' to canvas overlay for performance. The threshold calculation is done as follows: \cr
125125
#' if the number of points (in case of point data) or vertices (in case of
126126
#' polygon or line data) > \code{maxpoints} then render using special render
127127
#' function. Within this render function we approximate the complexity of
@@ -460,7 +460,7 @@ setMethod('mapView', signature(x = 'SpatRaster'), .stars_method)
460460

461461

462462
## Raster Stack/Brick ===========================================================
463-
#' @describeIn mapView \code{\link{stack}} / \code{\link{brick}}
463+
#' @describeIn mapView \code{\link[raster]{stack}} / \code{\link[raster]{brick}}
464464

465465
setMethod('mapView', signature(x = 'RasterStackBrick'),
466466
function(x,
@@ -531,7 +531,7 @@ setMethod('mapView', signature(x = 'RasterStackBrick'),
531531

532532

533533
## Satellite object =======================================================
534-
#' @describeIn mapView \code{\link{satellite}}
534+
#' @describeIn mapView \code{\link[satellite]{satellite}}
535535

536536
setMethod('mapView', signature(x = 'Satellite'),
537537
function(x,
@@ -840,7 +840,7 @@ setMethod('mapView', signature(x = 'SpatVector'), .sf_method)
840840

841841

842842
## sfc ====================================================================
843-
#' @describeIn mapView \code{\link{st_sfc}}
843+
#' @describeIn mapView \code{\link[sf]{st_sfc}}
844844

845845
setMethod('mapView', signature(x = 'sfc'),
846846
function(x,
@@ -1108,7 +1108,7 @@ setMethod('mapView', signature(x = 'numeric'),
11081108
#' @param aspect the ratio of x/y axis corrdinates to adjust the plotting
11091109
#' space to fit the screen. Only relevant for the data.frame method.
11101110
#' @param crs an optional crs specification for the provided data to enable
1111-
#' rendering on a basemap. See argument description in \code{\link{st_sf}}
1111+
#' rendering on a basemap. See argument description in \code{\link[sf]{st_sf}}
11121112
#' for details.
11131113
setMethod('mapView', signature(x = 'data.frame'),
11141114
function(x,
@@ -1151,7 +1151,7 @@ setMethod('mapView', signature(x = 'data.frame'),
11511151

11521152

11531153
## XY =====================================================================
1154-
#' @describeIn mapView \code{\link{st_sfc}}
1154+
#' @describeIn mapView \code{\link[sf]{st_sfc}}
11551155

11561156
setMethod('mapView', signature(x = 'XY'),
11571157
function(x,
@@ -1219,7 +1219,7 @@ setMethod('mapView', signature(x = 'XY'),
12191219

12201220

12211221
## XYZ ====================================================================
1222-
#' @describeIn mapView \code{\link{st_sfc}}
1222+
#' @describeIn mapView \code{\link[sf]{st_sfc}}
12231223

12241224
setMethod('mapView', signature(x = 'XYZ'),
12251225
function(x,
@@ -1233,7 +1233,7 @@ setMethod('mapView', signature(x = 'XYZ'),
12331233

12341234

12351235
## XYM ====================================================================
1236-
#' @describeIn mapView \code{\link{st_sfc}}
1236+
#' @describeIn mapView \code{\link[sf]{st_sfc}}
12371237

12381238
setMethod('mapView', signature(x = 'XYM'),
12391239
function(x,
@@ -1247,7 +1247,7 @@ setMethod('mapView', signature(x = 'XYM'),
12471247

12481248

12491249
## XYZM ===================================================================
1250-
#' @describeIn mapView \code{\link{st_sfc}}
1250+
#' @describeIn mapView \code{\link[sf]{st_sfc}}
12511251

12521252
setMethod('mapView', signature(x = 'XYZM'),
12531253
function(x,
@@ -1261,7 +1261,7 @@ setMethod('mapView', signature(x = 'XYZM'),
12611261

12621262

12631263
## bbox =======================================================
1264-
#' @describeIn mapView \code{\link{st_bbox}}
1264+
#' @describeIn mapView \code{\link[sf]{st_bbox}}
12651265

12661266
setMethod('mapView', signature(x = 'bbox'),
12671267
function(x,
@@ -1416,7 +1416,7 @@ setMethod('mapview', signature('ANY'),
14161416
######## SP ###############################################################
14171417

14181418
## SpatialPixelsDataFrame =================================================
1419-
#' @describeIn mapView \code{\link{SpatialPixelsDataFrame}}
1419+
#' @describeIn mapView \code{\link[sp]{SpatialPixelsDataFrame}}
14201420
#'
14211421
setMethod('mapView', signature(x = 'SpatialPixelsDataFrame'),
14221422
function(x,
@@ -1482,7 +1482,7 @@ setMethod('mapView', signature(x = 'SpatialPixelsDataFrame'),
14821482

14831483

14841484
## SpatialGridDataFrame =================================================
1485-
#' @describeIn mapView \code{\link{SpatialGridDataFrame}}
1485+
#' @describeIn mapView \code{\link[sp]{SpatialGridDataFrame}}
14861486
#'
14871487
setMethod('mapView', signature(x = 'SpatialGridDataFrame'),
14881488
function(x,
@@ -1548,7 +1548,7 @@ setMethod('mapView', signature(x = 'SpatialGridDataFrame'),
15481548

15491549

15501550
## SpatialPointsDataFrame =================================================
1551-
#' @describeIn mapView \code{\link{SpatialPointsDataFrame}}
1551+
#' @describeIn mapView \code{\link[sp]{SpatialPointsDataFrame}}
15521552
setMethod('mapView', signature(x = 'SpatialPointsDataFrame'),
15531553
function(x,
15541554
zcol = NULL,
@@ -1562,7 +1562,7 @@ setMethod('mapView', signature(x = 'SpatialPointsDataFrame'),
15621562

15631563

15641564
## SpatialPoints ==========================================================
1565-
#' @describeIn mapView \code{\link{SpatialPoints}}
1565+
#' @describeIn mapView \code{\link[sp]{SpatialPoints}}
15661566

15671567
setMethod('mapView', signature(x = 'SpatialPoints'),
15681568
function(x,
@@ -1577,7 +1577,7 @@ setMethod('mapView', signature(x = 'SpatialPoints'),
15771577

15781578

15791579
## SpatialPolygonsDataFrame ===============================================
1580-
#' @describeIn mapView \code{\link{SpatialPolygonsDataFrame}}
1580+
#' @describeIn mapView \code{\link[sp]{SpatialPolygonsDataFrame}}
15811581

15821582
setMethod('mapView', signature(x = 'SpatialPolygonsDataFrame'),
15831583
function(x,
@@ -1592,7 +1592,7 @@ setMethod('mapView', signature(x = 'SpatialPolygonsDataFrame'),
15921592

15931593

15941594
## SpatialPolygons ========================================================
1595-
#' @describeIn mapView \code{\link{SpatialPolygons}}
1595+
#' @describeIn mapView \code{\link[sp]{SpatialPolygons}}
15961596

15971597
setMethod('mapView', signature(x = 'SpatialPolygons'),
15981598
function(x,
@@ -1607,7 +1607,7 @@ setMethod('mapView', signature(x = 'SpatialPolygons'),
16071607

16081608

16091609
## SpatialLinesDataFrame =================================================
1610-
#' @describeIn mapView \code{\link{SpatialLinesDataFrame}}
1610+
#' @describeIn mapView \code{\link[sp]{SpatialLinesDataFrame}}
16111611

16121612
setMethod('mapView', signature(x = 'SpatialLinesDataFrame'),
16131613
function(x,
@@ -1622,7 +1622,7 @@ setMethod('mapView', signature(x = 'SpatialLinesDataFrame'),
16221622

16231623

16241624
## SpatialLines ===========================================================
1625-
#' @describeIn mapView \code{\link{SpatialLines}}
1625+
#' @describeIn mapView \code{\link[sp]{SpatialLines}}
16261626

16271627
setMethod('mapView', signature(x = 'SpatialLines'),
16281628
function(x,

R/options.R

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@
4141
#' @param homebutton.pos character. Where should the homebutton(s) be
4242
#' placed? One of "topleft", "topright", "bottomleft", "bottomright".
4343
#' @param native.crs logical whether to reproject to web map coordinate
44-
#' reference system (web mercator - epsg:3857) or render using native CRS of
44+
#' reference system (web Mercator - epsg:3857) or render using native CRS of
4545
#' the supplied data (can also be NA). Default is FALSE which will render in
46-
#' web mercator. If set to TRUE now background maps will be drawn (but rendering
46+
#' web Mercator. If set to TRUE now background maps will be drawn (but rendering
4747
#' may be much quicker as no reprojecting is necessary).
48-
#' @param raster.size numeric. see the maxBytes argument in \code{\link{addRasterImage}}
48+
#' @param raster.size numeric. see the maxBytes argument in \code{\link[leaflet]{addRasterImage}}
4949
#' @param mapview.maxpixels numeric. The maximum amount of pixels allowed for Raster*
5050
#' objects to be rendered with \code{mapview}. Defaults to 500000.
5151
#' Set this higher if you have a potent machine or are patient enough to wait a little.
@@ -66,7 +66,7 @@
6666
#' @param query.digits for raster methods only. The amount of digits to be shown
6767
#' by raster value query. Ignored if \code{label = FALSE}.
6868
#' @param query.position for raster methods only. The position of the raster
69-
#' value query info box. See \code{position} argument of \code{\link{addLegend}}
69+
#' value query info box. See \code{position} argument of \code{\link[leaflet]{addLegend}}
7070
#' for possible values. Ignored if \code{label = FALSE}.
7171
#' @param query.prefix for raster methods only. a character string to be shown
7272
#' as prefix for the layerId. Ignored if \code{label = FALSE}.
@@ -86,22 +86,22 @@
8686
#' This means that standard functionality is reduced.
8787
#' For example adding layers via "+" is not possible anymore.
8888
#' @param pane name of the map pane in which to render features. See
89-
#' \code{\link{addMapPane}} for details. Currently only supported for vector layers.
89+
#' \code{\link[leaflet]{addMapPane}} for details. Currently only supported for vector layers.
9090
#' Ignored if \code{canvas = TRUE}. The default \code{"auto"} will create different panes
9191
#' for points, lines and polygons such that points overlay lines overlay polygons.
92-
#' Set to \code{NULL} to get default leaflet behaviour where allfeatures
92+
#' Set to \code{NULL} to get default leaflet behaviour where all features
9393
#' are rendered in the same pane and layer order is determined automatically/sequentially.
9494
#' @param cex numeric or attribute name(s) or column number(s) in attribute table
9595
#' of the column(s) to be used for defining the size of circles.
9696
#' @param alpha opacity of lines.
9797
#' @param watch whether to watch a certain environment and automatically
9898
#' render changes to the list of spatial data in that environment. See
9999
#' \link{mapviewWatcher} for details.
100-
#' @param fgb if set to \code{TRUE} mapview will not use 'clasical' leaflet/htmlwidgets
100+
#' @param fgb if set to \code{TRUE} mapview will not use 'classical' leaflet/htmlwidgets
101101
#' rendering (which embeds data directly in the html) but leverage the speed of
102102
#' a file format called flatgeobuf (hence, fgb). This has the added benefit that
103103
#' data is being streamed onto the map, which makes for a pleasant user experience.
104-
#' It should also help to visualise larger data sets due to a reduced memeory footprint.
104+
#' It should also help to visualise larger data sets due to a reduced memory footprint.
105105
#' A note of warning, data will be attached to the html
106106
#' via a <src=...> call which means that the html is not selfcontained anymore
107107
#' (so it cannot be used without an accompanying folder).
@@ -118,7 +118,7 @@
118118
#' If no arguments are provided the options are printed.
119119
#'
120120
#' @seealso
121-
#' \code{\link{rasterOptions}}, \code{\link{options}}
121+
#' \code{\link[raster]{rasterOptions}}, \code{\link{options}}
122122
#'
123123
#' @examples
124124
#' mapviewOptions()

R/shiny-mapview.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#'
33
#' @param expr An expression that generates an HTML widget
44
#' @param env The environment in which to evaluate expr
5-
#' @param quoted Is expr a quoted expression (with quote())?
5+
#' @param quoted Is `expr` a quoted expression (with `quote()`)?
66
#' This is useful if you want to save an expression in a variable
77
#'
88
#' @export
@@ -19,7 +19,7 @@ renderMapview <- function(expr, env = parent.frame(), quoted = FALSE) {
1919
#'
2020
#' @param outputId Output variable to read from
2121
#' @param width,height the width and height of the map
22-
#' (see \code{\link{shinyWidgetOutput}})
22+
#' (see \code{\link[htmlwidgets]{shinyWidgetOutput}})
2323
#'
2424
#' @export
2525
#'

R/viewRGB.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
#' that they represent the red, green and blue channel. This function can
88
#' be used to make 'true (or false) color images' from Landsat and other
99
#' multi-band satellite images. Note, this text is plagiarized, i.e. copied
10-
#' from \code{\link{plotRGB}}.
10+
#' from [raster::plotRGB()].
1111
#'
1212
#' @param x a RasterBrick, RasterStack
1313
#' @param r integer. Index of the Red channel/band, between 1 and nlayers(x)

0 commit comments

Comments
 (0)