From 81811bffaa854e235cd8e87746fb7807453b51ce Mon Sep 17 00:00:00 2001 From: Sebastian Gatscha Date: Fri, 19 Jul 2024 08:25:34 +0200 Subject: [PATCH] fix: Rd cross-references NOTE --- DESCRIPTION | 2 +- R/tangram.R | 5 +---- man/addTangram.Rd | 11 +++++++---- man/isSynced.Rd | 2 +- man/leafletsyncOptions.Rd | 2 +- man/playbackOptions.Rd | 2 +- man/unsync.Rd | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 7bd6d383..3e420059 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -31,4 +31,4 @@ Suggests: curl URL: https://trafficonese.github.io/leaflet.extras2/, https://github.com/trafficonese/leaflet.extras2 BugReports: https://github.com/trafficonese/leaflet.extras2/issues -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.1 diff --git a/R/tangram.R b/R/tangram.R index 53de9f6e..3127a349 100644 --- a/R/tangram.R +++ b/R/tangram.R @@ -10,16 +10,12 @@ tangram_deps <- function() { #' Adds a Tangram layer to a Leaflet map in a Shiny App. #' -#' @param map A leaflet map widget #' @param scene Path to a required \bold{.yaml} or \bold{.zip} file. If the file #' is within the \code{/www} folder of a Shiny-App, only the filename must be #' given, otherwise the full path is needed. See the #' \href{https://github.com/tangrams/tangram}{Tangram repository} or the #' \href{https://tangrams.readthedocs.io/en/latest/}{Tangram docs} for further #' information on how to edit such a .yaml file. -#' @param layerId A layer ID -#' @param group The name of the group the newly created layer should belong to -#' (for \code{\link{clearGroup}} and \code{\link{addLayersControl}} purposes). #' @param options A list of further options. See the app in the #' \code{examples/tangram} folder or the #' \href{https://tangrams.readthedocs.io/en/latest/Overviews/Tangram-Overview/#leaflet}{docs} @@ -27,6 +23,7 @@ tangram_deps <- function() { #' @note Only works correctly in a Shiny-App environment. #' @references \url{https://github.com/tangrams/tangram} #' @family Tangram Functions +#' @inheritParams leaflet::addPolygons #' @inherit leaflet::addWMSTiles return #' @export #' @examples \dontrun{ diff --git a/man/addTangram.Rd b/man/addTangram.Rd index a1cee263..082e9b77 100644 --- a/man/addTangram.Rd +++ b/man/addTangram.Rd @@ -7,7 +7,7 @@ addTangram(map, scene = NULL, layerId = NULL, group = NULL, options = NULL) } \arguments{ -\item{map}{A leaflet map widget} +\item{map}{a map widget object created from \code{\link[leaflet]{leaflet}()}} \item{scene}{Path to a required \bold{.yaml} or \bold{.zip} file. If the file is within the \code{/www} folder of a Shiny-App, only the filename must be @@ -16,10 +16,13 @@ given, otherwise the full path is needed. See the \href{https://tangrams.readthedocs.io/en/latest/}{Tangram docs} for further information on how to edit such a .yaml file.} -\item{layerId}{A layer ID} +\item{layerId}{the layer id} -\item{group}{The name of the group the newly created layer should belong to -(for \code{\link{clearGroup}} and \code{\link{addLayersControl}} purposes).} +\item{group}{the name of the group the newly created layers should belong to +(for \code{\link[leaflet]{clearGroup}} and \code{\link[leaflet]{addLayersControl}} purposes). +Human-friendly group names are permitted--they need not be short, +identifier-style names. Any number of layers and even different types of +layers (e.g. markers and polygons) can share the same group name.} \item{options}{A list of further options. See the app in the \code{examples/tangram} folder or the diff --git a/man/isSynced.Rd b/man/isSynced.Rd index 37b8e3a8..a58ddb3d 100644 --- a/man/isSynced.Rd +++ b/man/isSynced.Rd @@ -30,8 +30,8 @@ For a map with id \code{map1} the input can be retrieved with } \seealso{ Other leafletsync Functions: -\code{\link{addLeafletsyncDependency}()}, \code{\link{addLeafletsync}()}, +\code{\link{addLeafletsyncDependency}()}, \code{\link{leafletsyncOptions}()}, \code{\link{unsync}()} } diff --git a/man/leafletsyncOptions.Rd b/man/leafletsyncOptions.Rd index 4f0ba034..55a98eaa 100644 --- a/man/leafletsyncOptions.Rd +++ b/man/leafletsyncOptions.Rd @@ -27,8 +27,8 @@ Additional list of options. } \seealso{ Other leafletsync Functions: -\code{\link{addLeafletsyncDependency}()}, \code{\link{addLeafletsync}()}, +\code{\link{addLeafletsyncDependency}()}, \code{\link{isSynced}()}, \code{\link{unsync}()} } diff --git a/man/playbackOptions.Rd b/man/playbackOptions.Rd index a8678770..3b3d9d84 100644 --- a/man/playbackOptions.Rd +++ b/man/playbackOptions.Rd @@ -31,7 +31,7 @@ improve performance, at the cost of animation smoothness. Default is 250} \item{speed}{Set float multiplier for default animation speed. Default is 50} -\item{maxInterpolationTime}{Set max interpolation time in seconds. +\item{maxInterpolationTime}{Set max interpolation time in milliseconds. Default is 5*60*1000 (5 minutes).} \item{tracksLayer}{Set \code{TRUE} if you want to show layer control on the diff --git a/man/unsync.Rd b/man/unsync.Rd index fcd59817..33f976b2 100644 --- a/man/unsync.Rd +++ b/man/unsync.Rd @@ -21,8 +21,8 @@ Removes the synchronization of multiple maps from a specific map. } \seealso{ Other leafletsync Functions: -\code{\link{addLeafletsyncDependency}()}, \code{\link{addLeafletsync}()}, +\code{\link{addLeafletsyncDependency}()}, \code{\link{isSynced}()}, \code{\link{leafletsyncOptions}()} }