From 70323efa473a803592b67f45a536e110beaa509b Mon Sep 17 00:00:00 2001 From: pvictor Date: Mon, 28 Oct 2024 09:17:51 +0100 Subject: [PATCH] reexports as CRAN request --- R/reexports.R | 8 ++++---- man/JS.Rd | 19 +++++++++++++++++++ man/aes.Rd | 25 +++++++++++++++++++++++++ man/label_value.Rd | 23 +++++++++++++++++++++++ man/pipe.Rd | 20 ++++++++++++++++++++ man/vars.Rd | 21 +++++++++++++++++++++ man/vchartr-exports.Rd | 15 --------------- 7 files changed, 112 insertions(+), 19 deletions(-) create mode 100644 man/JS.Rd create mode 100644 man/aes.Rd create mode 100644 man/label_value.Rd create mode 100644 man/pipe.Rd create mode 100644 man/vars.Rd delete mode 100644 man/vchartr-exports.Rd diff --git a/R/reexports.R b/R/reexports.R index 1d4f3fa..f9be030 100644 --- a/R/reexports.R +++ b/R/reexports.R @@ -25,7 +25,7 @@ NULL #' @usage JS(...) #' @inheritParams htmlwidgets::JS #' @return A string that will be interpreted as JavaScript code in htmlwidgets. -NULL +htmlwidgets::JS #' Construct aesthetic mappings #' @@ -38,7 +38,7 @@ NULL #' @usage aes(x, y, ...) #' @inheritParams ggplot2::aes #' @return A list with class `uneval`. Components of the list are either quosures or constants. -NULL +ggplot2::aes #' Quote faceting variables #' @@ -51,7 +51,7 @@ NULL #' @usage vars(...) #' @inheritParams ggplot2::vars #' @return A list with class `uneval`. Components of the list are either quosures or constants. -NULL +ggplot2::vars #' Useful labeller functions #' @@ -64,4 +64,4 @@ NULL #' @usage label_value(labels, multi_line = TRUE) #' @inheritParams ggplot2::label_value #' @return Labels to be used in a facetted chart. -NULL +ggplot2::label_value diff --git a/man/JS.Rd b/man/JS.Rd new file mode 100644 index 0000000..004a758 --- /dev/null +++ b/man/JS.Rd @@ -0,0 +1,19 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/reexports.R +\name{JS} +\alias{JS} +\title{Mark character strings as literal JavaScript code} +\usage{ +JS(...) +} +\arguments{ +\item{...}{character vectors as the JavaScript source code (all arguments +will be pasted into one character string)} +} +\value{ +A string that will be interpreted as JavaScript code in htmlwidgets. +} +\description{ +See \code{\link[htmlwidgets:JS]{htmlwidgets::JS()}} for details. +} +\keyword{internal} diff --git a/man/aes.Rd b/man/aes.Rd new file mode 100644 index 0000000..72fabf6 --- /dev/null +++ b/man/aes.Rd @@ -0,0 +1,25 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/reexports.R +\name{aes} +\alias{aes} +\title{Construct aesthetic mappings} +\usage{ +aes(x, y, ...) +} +\arguments{ +\item{x, y, ...}{<\code{\link[rlang:topic-data-mask]{data-masking}}> List of name-value +pairs in the form \code{aesthetic = variable} describing which variables in the +layer data should be mapped to which aesthetics used by the paired +geom/stat. The expression \code{variable} is evaluated within the layer data, so +there is no need to refer to the original dataset (i.e., use +\code{ggplot(df, aes(variable))} instead of \code{ggplot(df, aes(df$variable))}). +The names for x and y aesthetics are typically omitted because they are so +common; all other aesthetics must be named.} +} +\value{ +A list with class \code{uneval}. Components of the list are either quosures or constants. +} +\description{ +See \code{\link[ggplot2:aes]{ggplot2::aes()}} for details. +} +\keyword{internal} diff --git a/man/label_value.Rd b/man/label_value.Rd new file mode 100644 index 0000000..9efc2aa --- /dev/null +++ b/man/label_value.Rd @@ -0,0 +1,23 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/reexports.R +\name{label_value} +\alias{label_value} +\title{Useful labeller functions} +\usage{ +label_value(labels, multi_line = TRUE) +} +\arguments{ +\item{labels}{Data frame of labels. Usually contains only one +element, but faceting over multiple factors entails multiple +label variables.} + +\item{multi_line}{Whether to display the labels of multiple factors +on separate lines.} +} +\value{ +Labels to be used in a facetted chart. +} +\description{ +See \code{\link[ggplot2:labellers]{ggplot2::label_value()}} for details. +} +\keyword{internal} diff --git a/man/pipe.Rd b/man/pipe.Rd new file mode 100644 index 0000000..4cfab13 --- /dev/null +++ b/man/pipe.Rd @@ -0,0 +1,20 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/reexports.R +\name{\%>\%} +\alias{\%>\%} +\title{Pipe operator} +\usage{ +lhs \%>\% rhs +} +\arguments{ +\item{lhs}{A value or the magrittr placeholder.} + +\item{rhs}{A function call using the magrittr semantics.} +} +\value{ +The result of calling \code{rhs(lhs)}. +} +\description{ +See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details. +} +\keyword{internal} diff --git a/man/vars.Rd b/man/vars.Rd new file mode 100644 index 0000000..18d9f2a --- /dev/null +++ b/man/vars.Rd @@ -0,0 +1,21 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/reexports.R +\name{vars} +\alias{vars} +\title{Quote faceting variables} +\usage{ +vars(...) +} +\arguments{ +\item{...}{<\code{\link[rlang:topic-data-mask]{data-masking}}> Variables or +expressions automatically quoted. These are evaluated in the context of the +data to form faceting groups. Can be named (the names are passed to a +\link[ggplot2:labellers]{labeller}).} +} +\value{ +A list with class \code{uneval}. Components of the list are either quosures or constants. +} +\description{ +See \code{\link[ggplot2:vars]{ggplot2::vars()}} for details. +} +\keyword{internal} diff --git a/man/vchartr-exports.Rd b/man/vchartr-exports.Rd deleted file mode 100644 index d85d8bf..0000000 --- a/man/vchartr-exports.Rd +++ /dev/null @@ -1,15 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/vchart-package.R -\name{vchartr-exports} -\alias{vchartr-exports} -\alias{\%>\%} -\alias{aes} -\alias{vars} -\alias{label_value} -\alias{JS} -\title{vchartr exported operators and S3 methods} -\description{ -The following functions are imported and then re-exported -from the vchartr package to avoid listing the magrittr -as Depends of vchartr -}