Skip to content

Commit

Permalink
fix: Rd cross-references NOTE
Browse files Browse the repository at this point in the history
  • Loading branch information
trafficonese committed Jul 19, 2024
1 parent d04a4e9 commit 81811bf
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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
5 changes: 1 addition & 4 deletions R/tangram.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,20 @@ 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}
#' for further information.
#' @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{
Expand Down
11 changes: 7 additions & 4 deletions man/addTangram.Rd

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

2 changes: 1 addition & 1 deletion man/isSynced.Rd

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

2 changes: 1 addition & 1 deletion man/leafletsyncOptions.Rd

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

2 changes: 1 addition & 1 deletion man/playbackOptions.Rd

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

2 changes: 1 addition & 1 deletion man/unsync.Rd

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

0 comments on commit 81811bf

Please sign in to comment.