From a30c25035829e66dedaeeb42e8c5d97828b345c3 Mon Sep 17 00:00:00 2001 From: olivroy Date: Thu, 6 Jun 2024 22:09:32 -0400 Subject: [PATCH] fix typo, refer to `tm_scale_intervals()`, avoid auto-refs --- R/tm_scale_.R | 7 ++----- man/tm_scale_categorical.Rd | 2 +- man/tm_scale_intervals.Rd | 2 +- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/R/tm_scale_.R b/R/tm_scale_.R index 51541e0c..67a85b58 100644 --- a/R/tm_scale_.R +++ b/R/tm_scale_.R @@ -54,7 +54,6 @@ tm_scale_asis = function(values.scale = NA, value.neutral = NA, ...) { } #' @export -#' @name tm_scale_ordinal #' @rdname tm_scale_categorical tm_scale_ordinal = function(n.max = 30, values = NA, # e.g. palette, shape numbers, set of sizes (if two values are specified they are interpret as range) @@ -78,7 +77,7 @@ tm_scale_ordinal = function(n.max = 30, #' Scales in tmap are configured by the family of functions with prefix `tm_scale`. #' Such function should be used for the input of the `.scale` arguments in the #' layer functions (e.g. `fill.scale` in [tm_polygons()]). -#' The functions [tm_scale_categorical()] and [tm_scale_ordinal()] are used +#' The functions `tm_scale_categorical()` and `tm_scale_ordinal()` are used #' for categorical data. The only difference between these functions is that the #' former assumes unordered categories whereas the latter assumes ordered categories. #' For colors (the visual variable `fill` or `col`), different default color @@ -100,8 +99,6 @@ tm_scale_ordinal = function(n.max = 30, #' @param label.format (generic scale argument) Label formatting (similar to `legend.format` in tmap3) #' @seealso [tm_scale()] #' @export -#' @name tm_scale_categorical -#' @rdname tm_scale_categorical tm_scale_categorical = function(n.max = 30, values = NA, # e.g. palette, shape numbers, set of sizes (if two values are specified they are interpret as range) values.repeat = TRUE, @@ -124,7 +121,7 @@ tm_scale_categorical = function(n.max = 30, #' Scales in tmap are configured by the family of functions with prefix `tm_scale`. #' Such function should be used for the input of the `.scale` arguments in the #' layer functions (e.g. `fill.scale` in [tm_polygons()]). -#' The function [tm_scale_interval()] is used for numerical data. +#' The function `tm_scale_intervals()` is used for numerical data. #' #' @param n Number of intervals. For some styles (see argument `style` below) it is the preferred number rather than the exact number. #' @param style Method to create intervals. Options are `"cat"`, `"fixed"`, `"sd"`, `"equal"`, `"pretty"`, `"quantile"`, `"kmeans"`, `"hclust"`, `"bclust"`, `"fisher"`, `"jenks"`, `"dpih"`, `"headtails"`, and `"log10_pretty"`. See the details in [classInt::classIntervals()] (extra arguments can be passed on via `style.args`). diff --git a/man/tm_scale_categorical.Rd b/man/tm_scale_categorical.Rd index 9cdf7fb0..74caf7a4 100644 --- a/man/tm_scale_categorical.Rd +++ b/man/tm_scale_categorical.Rd @@ -72,7 +72,7 @@ tm_scale_categorical( Scales in tmap are configured by the family of functions with prefix \code{tm_scale}. Such function should be used for the input of the \code{.scale} arguments in the layer functions (e.g. \code{fill.scale} in \code{\link[=tm_polygons]{tm_polygons()}}). -The functions \code{\link[=tm_scale_categorical]{tm_scale_categorical()}} and \code{\link[=tm_scale_ordinal]{tm_scale_ordinal()}} are used +The functions \code{tm_scale_categorical()} and \code{tm_scale_ordinal()} are used for categorical data. The only difference between these functions is that the former assumes unordered categories whereas the latter assumes ordered categories. For colors (the visual variable \code{fill} or \code{col}), different default color diff --git a/man/tm_scale_intervals.Rd b/man/tm_scale_intervals.Rd index 7b0678c3..c1f9919d 100644 --- a/man/tm_scale_intervals.Rd +++ b/man/tm_scale_intervals.Rd @@ -66,7 +66,7 @@ tm_scale_intervals( Scales in tmap are configured by the family of functions with prefix \code{tm_scale}. Such function should be used for the input of the \code{.scale} arguments in the layer functions (e.g. \code{fill.scale} in \code{\link[=tm_polygons]{tm_polygons()}}). -The function \code{\link[=tm_scale_interval]{tm_scale_interval()}} is used for numerical data. +The function \code{tm_scale_intervals()} is used for numerical data. } \seealso{ \code{\link[=tm_scale]{tm_scale()}}