From 94e870a15ddaca347f36b88fa85663f99a15cd3c Mon Sep 17 00:00:00 2001 From: David Gohel Date: Tue, 19 Nov 2024 13:34:13 +0100 Subject: [PATCH] doc: fix cross references --- DESCRIPTION | 2 +- R/element_interactive.R | 2 +- R/labeller_interactive.R | 8 ++++---- man/element_interactive.Rd | 2 +- man/labeller_interactive.Rd | 8 ++++---- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 236199a..5bf03db 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Type: Package Package: ggiraph Title: Make 'ggplot2' Graphics Interactive -Version: 0.9.0.003 +Version: 0.9.0.004 Authors@R: c( person("David", "Gohel", , "david.gohel@ardata.fr", role = c("aut", "cre")), person("Panagiotis", "Skintzos", , "sigmapi@posteo.net", role = "aut"), diff --git a/R/element_interactive.R b/R/element_interactive.R index 07940a6..a2bf9c6 100644 --- a/R/element_interactive.R +++ b/R/element_interactive.R @@ -1,7 +1,7 @@ #' @title Create interactive theme elements #' #' @description -#' With these functions the user can add interactivity to various [theme][ggplot2::theme] +#' With these functions the user can add interactivity to various [ggplot2::theme()] #' elements. #' #' They are based on [ggplot2::element_rect()], diff --git a/R/labeller_interactive.R b/R/labeller_interactive.R index 48b1a56..7193be9 100644 --- a/R/labeller_interactive.R +++ b/R/labeller_interactive.R @@ -2,10 +2,10 @@ #' @title Construct interactive labelling specification for facet strips #' #' @description -#' This function is a wrapper around [labeller()] that allows the user to turn +#' This function is a wrapper around [ggplot2::labeller()] that allows the user to turn #' facet strip labels into interactive labels via [label_interactive()]. #' -#' It requires that the [theme()]'s `strip.text` elements are defined as interactive +#' It requires that the [ggplot2::theme()]'s `strip.text` elements are defined as interactive #' theme elements via [element_text_interactive()], see details. #' #' @details @@ -19,14 +19,14 @@ #' `theme(strip.text.x = element_text_interactive())` #' `theme(strip.text.y = element_text_interactive())` #' -#' @param ... arguments passed to base function [labeller()] +#' @param ... arguments passed to base function [ggplot2::labeller()] #' @param .mapping set of aesthetic mappings created by [ggplot2::aes()] or [ggplot2::aes_()]. #' It should provide mappings for any of the [interactive_parameters]. #' In addition it understands a `label` parameter for creating a new label text. #' @examples #' # use interactive labeller #' @example examples/labeller_interactive.R -#' @seealso [labeller()], [label_interactive()], [labellers] +#' @seealso [ggplot2::labeller()], [label_interactive()], [ggplot2::labellers] #' @importFrom rlang eval_tidy list2 #' @importFrom purrr imap labeller_interactive <- function(.mapping = NULL, ...) { diff --git a/man/element_interactive.Rd b/man/element_interactive.Rd index 74c93b8..040691f 100644 --- a/man/element_interactive.Rd +++ b/man/element_interactive.Rd @@ -17,7 +17,7 @@ element_text_interactive(...) plus any of the \link{interactive_parameters}.} } \description{ -With these functions the user can add interactivity to various \link[ggplot2:theme]{theme} +With these functions the user can add interactivity to various \code{\link[ggplot2:theme]{ggplot2::theme()}} elements. They are based on \code{\link[ggplot2:element]{ggplot2::element_rect()}}, diff --git a/man/labeller_interactive.Rd b/man/labeller_interactive.Rd index f5589fd..1981d8e 100644 --- a/man/labeller_interactive.Rd +++ b/man/labeller_interactive.Rd @@ -11,13 +11,13 @@ labeller_interactive(.mapping = NULL, ...) It should provide mappings for any of the \link{interactive_parameters}. In addition it understands a \code{label} parameter for creating a new label text.} -\item{...}{arguments passed to base function \code{\link[=labeller]{labeller()}}} +\item{...}{arguments passed to base function \code{\link[ggplot2:labeller]{ggplot2::labeller()}}} } \description{ -This function is a wrapper around \code{\link[=labeller]{labeller()}} that allows the user to turn +This function is a wrapper around \code{\link[ggplot2:labeller]{ggplot2::labeller()}} that allows the user to turn facet strip labels into interactive labels via \code{\link[=label_interactive]{label_interactive()}}. -It requires that the \code{\link[=theme]{theme()}}'s \code{strip.text} elements are defined as interactive +It requires that the \code{\link[ggplot2:theme]{ggplot2::theme()}}'s \code{strip.text} elements are defined as interactive theme elements via \code{\link[=element_text_interactive]{element_text_interactive()}}, see details. } \details{ @@ -171,5 +171,5 @@ x <- girafe(ggobj = p) if (interactive()) print(x) } \seealso{ -\code{\link[=labeller]{labeller()}}, \code{\link[=label_interactive]{label_interactive()}}, \link{labellers} +\code{\link[ggplot2:labeller]{ggplot2::labeller()}}, \code{\link[=label_interactive]{label_interactive()}}, \link[ggplot2:labellers]{ggplot2::labellers} }