added internal exports

r-tmap · Jun 14, 2024 · 2d6d261 · 2d6d261
1 parent fd83478
commit 2d6d261
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 8 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -156,6 +156,8 @@ export(tm_compass)
 export(tm_const)
 export(tm_credits)
 export(tm_dots)
+export(tm_element)
+export(tm_element_list)
 export(tm_extra_innner_margin)
 export(tm_facets)
 export(tm_facets_flip)
@@ -205,6 +207,7 @@ export(tm_scale_asis)
 export(tm_scale_bar)
 export(tm_scale_bivariate)
 export(tm_scale_categorical)
+export(tm_scale_composition)
 export(tm_scale_continuous)
 export(tm_scale_continuous_log)
 export(tm_scale_continuous_log10)
@@ -235,12 +238,21 @@ export(tm_ylab)
 export(tmapAddLayerOptions)
 export(tmapGetShapeMeta1)
 export(tmapGetShapeMeta2)
+export(tmapGpar)
 export(tmapMode)
 export(tmapOutput)
 export(tmapProxy)
+export(tmapScale)
 export(tmapShape)
 export(tmapSplitShp)
 export(tmapSubsetShp)
+export(tmapTpar)
+export(tmapTransCartogram)
+export(tmapTransCentroid)
+export(tmapTransLines)
+export(tmapTransPolygons)
+export(tmapTransRaster)
+export(tmapUsrCls)
 export(tmap_animation)
 export(tmap_arrange)
 export(tmap_design_mode)

diff --git a/R/tm_element.R b/R/tm_element.R
@@ -1,7 +1,21 @@
+#' Internal methods for tmap extensions
+#' 
+#' Internal methods for tmap extensions
+#' 
+#' @param ... arguments
+#' @param subclass subclass
+#' @export
+#' @name tm_element
+#' @rdname tmap_internal
+#' @keywords internal
 tm_element = function(..., subclass = NULL) {
  structure(list(...), class = c(subclass, "tm_element", "list"))
 }
 
+#' @export
+#' @name tm_element_list
+#' @rdname tmap_internal
+#' @keywords internal
 tm_element_list = function(...) {
  structure(list(...), class = "tmap")
 }

diff --git a/R/tmapGpar.R b/R/tmapGpar.R
@@ -1,3 +1,9 @@
+#' @param fill,col,shape,size,fill_alpha,col_alpha,lty,lwd,linejoin,lineend visual variables
+#' @param ... args
+#' @export
+#' @name tmapGpar
+#' @rdname tmap_internal
+#' @keywords internal
 tmapGpar = function(fill = NULL,
  col = NULL,
  shape = NULL,
@@ -14,6 +20,10 @@ tmapGpar = function(fill = NULL,
  structure(args, class = "tmapGpar")
 }
 
+#' @export
+#' @name tmapTpar
+#' @rdname tmap_internal
+#' @keywords internal
 tmapTpar = function(...) {
  args = c(as.list(environment()), list(...))
  structure(args, class = "tmapTpar")

diff --git a/R/tmapScale_.R b/R/tmapScale_.R
@@ -36,6 +36,11 @@ tmapVars = function(x) {
  structure(x, class = cls)
 }
 
+#' @param x x
+#' @export
+#' @name tmapUsrCls
+#' @rdname tmap_internal
+#' @keywords internal
 tmapUsrCls = function(x) {
  structure(x, class = "tmapUsrCls")
 }
@@ -155,6 +160,16 @@ data_class = function(x, check_for_color_class = FALSE) {
 }
 
 
+#' @param aes aes
+#' @param value value
+#' @param scale scale
+#' @param legend legend
+#' @param chart chart
+#' @param free free
+#' @export
+#' @name tmapScale
+#' @rdname tmap_internal
+#' @keywords internal
 tmapScale = function(aes, value, scale, legend, chart, free) {
  structure(list(aes = aes, value = tmapVars(value), scale = scale, legend = legend, chart = chart, free = free), class = c("tmapScale", "list"))
 }

diff --git a/R/tmapTrans.R b/R/tmapTrans.R
@@ -67,10 +67,16 @@ get_midpoint_angle = function(shp) {
  list(shp = sf::st_geometry(pShp), angles = angles)
 }
 
-# args:
-# - points.only: "yes", "no", "ifany"
-# 
-# prop_ vectors, e.g. prop_angle can be added to shpTM. These are later put into dt (and used in step 4 (plotting))
+#' @param shpTM shpTM
+#' @param xmod,ymod xmod and ymod
+#' @param ord__ ord
+#' @param plot.order plot.order
+#' @param args args
+#' @param scale scale
+#' @export
+#' @name tmapTransCentroid
+#' @rdname tmap_internal
+#' @keywords internal
 tmapTransCentroid = function(shpTM, xmod = NULL, ymod = NULL, ord__, plot.order, args, scale) {
  within(shpTM, {
  is_stars = inherits(shp, "dimensions")
@@ -131,16 +137,26 @@ tmapTransCentroid = function(shpTM, xmod = NULL, ymod = NULL, ord__, plot.order,
  }
  })
 }
+# args:
+# - points.only: "yes", "no", "ifany"
+# 
+# prop_ vectors, e.g. prop_angle can be added to shpTM. These are later put into dt (and used in step 4 (plotting))
 
 
+#' @export
+#' @name tmapTransRaster
+#' @rdname tmap_internal
+#' @keywords internal
 tmapTransRaster = function(shpTM, ord__, plot.order, args) {
  if (!inherits(shpTM$shp, "dimensions")) stop("Stars object (of class dimensions) expected for tm_raster", call. = FALSE)
  shpTM
 }
 
 
-# args:
-# - polygons.only: "yes", "no", "ifany"
+#' @export
+#' @name tmapTransPolygons
+#' @rdname tmap_internal
+#' @keywords internal
 tmapTransPolygons = function(shpTM, ord__, plot.order, args, scale) {
  within(shpTM, {
  is_stars = inherits(shp, "dimensions")
@@ -189,9 +205,13 @@ tmapTransPolygons = function(shpTM, ord__, plot.order, args, scale) {
  }
  })
 }
-
 # args:
-# - lines.only: "yes", "no", "ifany"
+# - polygons.only: "yes", "no", "ifany"
+
+#' @export
+#' @name tmapTransLines
+#' @rdname tmap_internal
+#' @keywords internal
 tmapTransLines = function(shpTM, ord__, plot.order, args, scale) {
  within(shpTM, {
  is_stars = inherits(shp, "dimensions")
@@ -237,7 +257,13 @@ tmapTransLines = function(shpTM, ord__, plot.order, args, scale) {
  }
  })
 }
+# args:
+# - lines.only: "yes", "no", "ifany"
 
+#' @export
+#' @name tmapTransCartogram
+#' @rdname tmap_internal
+#' @keywords internal
 tmapTransCartogram = function(shpTM, size, ord__, plot.order, args, scale) {
  s = shpTM$shp