Skip to content

Commit

Permalink
renamed tmap_grid to tmap_grob
Browse files Browse the repository at this point in the history
  • Loading branch information
mtennekes committed Jul 21, 2024
1 parent 4fc4632 commit 75c14e3
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 20 deletions.
1 change: 0 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,6 @@ export(tmap_design_mode)
export(tmap_devel_mode)
export(tmap_format)
export(tmap_format_add)
export(tmap_grid)
export(tmap_grob)
export(tmap_icons)
export(tmap_last)
Expand Down
2 changes: 1 addition & 1 deletion R/tm_scale_.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tm_const = function() {
#' tmap function to specify all variables in the shape object
#'
#' @param n if specified, the first `n` shape variables are used
#' @param id index numbers of the used shape variables
#' @param ids index numbers of the used shape variables
#' @export
tm_shape_vars = function(ids = NA, n = NA) {
structure(list(ids = ids, n = n), class = c("tm_shape_vars", "list"))
Expand Down
8 changes: 4 additions & 4 deletions R/tmap_leaflet.R
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
#' Export tmap to the format of the used graphics mode
#'
#' * `tmap_grid()` returns a [`grob`][grid::grob()] object (`"plot" mode`)
#' * `tmap_grob()` returns a [`grob`][grid::grob()] object (`"plot" mode`)
#' * `tmap_leaflet()` a [`leaflet`][leaflet::leaflet()] object (`"view"` mode).
#'
#' @param x a tmap object.
#' @param show show the map?
#' @inheritDotParams print.tmap
#' @return
#' * `tmap_grid()` returns a [`grob`][grid::grob()] object (`"plot"` mode)
#' * `tmap_grob()` returns a [`grob`][grid::grob()] object (`"plot"` mode)
#' * `tmap_leaflet()` a [`leaflet`][leaflet::leaflet()] object (`"view"` mode).
#' In case small multiples are shown, a list is returned.
#' @export
Expand All @@ -28,10 +28,10 @@ tmap_leaflet = function(x,
print.tmap(x, show = show, ...)
}

#' @name tmap_grid
#' @name tmap_grob
#' @rdname tmap_leaflet
#' @export
tmap_grid = function(x,
tmap_grob = function(x,
show = FALSE,
...) {
current_mode = getOption("tmap.mode")
Expand Down
5 changes: 0 additions & 5 deletions R/v4-not-implemented.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@ tm_logo <- function(...) {
}
#' @export
#' @rdname v4-not-yet
tmap_grob <- function(...) {
stop("Not yet implemented in v4")
}
#' @export
#' @rdname v4-not-yet
tmap_tip <- function(...) {
stop("Not yet implemented in v4")
}
Expand Down
4 changes: 2 additions & 2 deletions man/tm_shape_vars.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/tmap_leaflet.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions man/v4-not-yet.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 75c14e3

Please sign in to comment.