-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add possibility to automatically mapview some environment
- Loading branch information
1 parent
d6b490e
commit 7abf070
Showing
9 changed files
with
261 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -85,6 +85,7 @@ Suggests: | |
| covr, | ||
| dplyr, | ||
| knitr, | ||
| later, | ||
| lwgeom, | ||
| mapdeck, | ||
| plainview, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| #' Start and/or stop automagic mapviewing of spatial objects in your workspace. | ||
| #' | ||
| #' @description | ||
| #' Use these functions to enable automatic vieweing of all spatial objects | ||
| #' currently available in \code{env}. \code{mapviewWatcher} uses | ||
| #' \link[later]{later} to set up a watcher function that continuously monitors | ||
| #' \code{env} for spatial objects and refreshes the viewer/browser in case | ||
| #' the list of spatial objects changes. | ||
| #' \cr | ||
| #' \cr | ||
| #' \code{startWatching} and \code{stopWatching} are convenience functions to | ||
| #' start and stop watching, respectively. | ||
| #' | ||
| #' @details | ||
| #' \code{mapviewWatcher} uses \code{\link{identical}} and hence | ||
| #' will redraw even if e.g. the attributes of a spatial object are changed only | ||
| #' slightly. By default \code{mapviewWatcher} watches the \code{.GlobalEnv} but | ||
| #' this can be changed to another environment. Whether watching is turned on is | ||
| #' controlled by \code{mapviewGetOption("watch")}. In order to enable watching it | ||
| #' needs to be set to \code{mapviewOptions(watch = TRUE)} | ||
| #' (default is \code{FALSE}) and the watcher needs to be initiated by calling | ||
| #' \code{mapviewWatcher()} once. To switch watching off it is sufficient to set | ||
| #' \code{mapviewOptions(watch = FALSE)}. | ||
| #' | ||
| #' @param env the environemnt that is being watched (default is \code{.GlobalEnv}). | ||
| #' @param ... currently not used. | ||
| #' | ||
| #' @examples | ||
| #' if (interactive()) { | ||
| #' library(mapview) | ||
| #' | ||
| #' ## start the watcher | ||
| #' mapview::startWatching() | ||
| #' | ||
| #' ## load some data and watch the automatic visualisation | ||
| #' fran = mapview::franconia | ||
| #' brew = mapview::breweries | ||
| #' | ||
| #' ## stop the watcher | ||
| #' mapview::stopWatching() | ||
| #' | ||
| #' ## loading or removing things now will not trigger a view update | ||
| #' rm(brew) | ||
| #' trls = mapview::trails | ||
| #' | ||
| #' ## re-starting the viewer will re-draw whatever is currently available | ||
| #' mapview::startWatching() | ||
| #' | ||
| #' ## watcher can also be stopped via mapviewOptions | ||
| #' mapviewOptions(watch = FALSE) | ||
| #' | ||
| #' rm(trls) | ||
| #' | ||
| #' } | ||
| #' | ||
| #' @export | ||
| #' @rdname mapviewWatcher | ||
| mapviewWatcher = function(env = .GlobalEnv, ...) { | ||
|
|
||
| if (!requireNamespace("later", quietly = TRUE)) { | ||
| stop( | ||
| "Please install.packages('later') to allow mapview to watch your workspace" | ||
| , call. = FALSE | ||
| ) | ||
| } | ||
|
|
||
| last_value = NULL | ||
|
|
||
| dir <- tempfile() | ||
| dir.create(dir) | ||
| htmlFile <- file.path(dir, "index.html") | ||
|
|
||
| mv_watch = function() { | ||
| if (!mapviewGetOption("watch")) return(invisible()) | ||
| spatdat_lst = getSpatialData(env = env) | ||
| if (length(spatdat_lst) > 0 && !identical(spatdat_lst, last_value)) { | ||
| m = mapview::mapView(spatdat_lst) | ||
| mapview::mapshot(m, htmlFile) | ||
|
|
||
| viewer <- getOption("viewer") | ||
| if (!is.null(viewer)) { | ||
| viewer(htmlFile) | ||
| } else { | ||
| utils::browseURL(htmlFile) | ||
| } | ||
| last_value <<- spatdat_lst | ||
| } | ||
|
|
||
| later::later(mv_watch, 0.25) | ||
| } | ||
|
|
||
| ## initiate the watcher | ||
| mv_watch() | ||
| } | ||
|
|
||
| #' @export | ||
| #' @describeIn mapviewWatcher start watching | ||
| startWatching = function(env = .GlobalEnv, ...) { | ||
| mapviewOptions(watch = TRUE) | ||
| mapviewWatcher(env = env) | ||
| } | ||
|
|
||
| #' @export | ||
| #' @describeIn mapviewWatcher stop watching | ||
| stopWatching = function(env = .GlobalEnv, ...) { | ||
| mapviewOptions(watch = FALSE) | ||
| } | ||
|
|
||
|
|
||
| ## helper | ||
| getSpatialData = function(env = .GlobalEnv) { | ||
| dat = ls(envir = env, sorted = FALSE) | ||
| cls = lapply(lapply(dat, get), class) | ||
|
|
||
| ## sf | ||
| sf_idx = grep("sf", cls) | ||
| sf_dat = as.list(dat[sf_idx]) | ||
| names(sf_dat) = dat[sf_idx] | ||
|
|
||
| ## sp | ||
| sp_idx = grep("Spatial", cls) | ||
| sp_dat = as.list(dat[sp_idx]) | ||
| names(sp_dat) = dat[sp_idx] | ||
|
|
||
| # stars | ||
| st_idx = grep("stars", cls) | ||
| st_dat = as.list(dat[st_idx]) | ||
| names(st_dat) = dat[st_idx] | ||
|
|
||
| ## raster | ||
| rs_idx = grep("Raster", cls) | ||
| rs_dat = as.list(dat[rs_idx]) | ||
| names(rs_dat) = dat[rs_idx] | ||
|
|
||
| ## combine and get | ||
| spatdat = Filter(Negate(is.null), c(sf_dat, sp_dat, st_dat, rs_dat)) | ||
|
|
||
| lapply(spatdat, get) | ||
| } | ||
|
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.