From 56d44e4ea58be4cf4dcf55f8c039ec175a78c3c6 Mon Sep 17 00:00:00 2001 From: mariusbarth Date: Tue, 22 Oct 2024 19:50:25 +0200 Subject: [PATCH] fixed docs of plot functions to pass CRAN checks --- R/apa_barplot.R | 2 +- R/apa_beeplot.R | 2 +- R/apa_lineplot.R | 3 +-- man/apa_barplot.Rd | 6 +----- man/apa_beeplot.Rd | 6 +----- man/apa_lineplot.Rd | 6 +----- 6 files changed, 6 insertions(+), 19 deletions(-) diff --git a/R/apa_barplot.R b/R/apa_barplot.R index 35df8065..fefe987e 100644 --- a/R/apa_barplot.R +++ b/R/apa_barplot.R @@ -4,7 +4,7 @@ #' a factorial design and set APA-friendly defaults. #' #' @inherit apa_factorial_plot -#' @inheritDotParams apa_factorial_plot +#' @param ... Further arguments passed on to [apa_factorial_plot()]. #' @family plots for factorial designs #' #' @examples diff --git a/R/apa_beeplot.R b/R/apa_beeplot.R index 82e27e11..a96000e3 100644 --- a/R/apa_beeplot.R +++ b/R/apa_beeplot.R @@ -4,7 +4,7 @@ #' a factorial design and set APA-friendly defaults. #' #' @inherit apa_factorial_plot -#' @inheritDotParams apa_factorial_plot +#' @param ... Further arguments passed on to [apa_factorial_plot()]. #' @family plots for factorial designs #' @examples #' apa_beeplot( diff --git a/R/apa_lineplot.R b/R/apa_lineplot.R index 1936b8dd..490e1993 100644 --- a/R/apa_lineplot.R +++ b/R/apa_lineplot.R @@ -4,7 +4,6 @@ #' a factorial design and set APA-friendly defaults. #' #' @inherit apa_factorial_plot -#' @inheritDotParams apa_factorial_plot #' #' @family plots for factorial designs #' @examples @@ -34,6 +33,7 @@ #' , las = 1 #' ) #' +#' @param ... Further arguments passed on to [apa_factorial_plot()]. #' @import grDevices #' @import graphics #' @rdname apa_lineplot @@ -44,7 +44,6 @@ apa_lineplot <- function(data, ...){ } - #' @rdname apa_lineplot #' @export diff --git a/man/apa_barplot.Rd b/man/apa_barplot.Rd index f93e6926..23e5bd40 100644 --- a/man/apa_barplot.Rd +++ b/man/apa_barplot.Rd @@ -45,11 +45,7 @@ apa_barplot(data, ...) \arguments{ \item{data}{A \code{data.frame} that contains the data, or an object of class \code{afex_aov}.} -\item{...}{ - Arguments passed on to \code{\link[=apa_factorial_plot]{apa_factorial_plot}} - \describe{ - \item{\code{}}{} - }} +\item{...}{Further arguments passed on to \code{\link[=apa_factorial_plot]{apa_factorial_plot()}}.} \item{id}{Character. Variable name that identifies subjects.} diff --git a/man/apa_beeplot.Rd b/man/apa_beeplot.Rd index 21ec8e91..a8d85f6c 100644 --- a/man/apa_beeplot.Rd +++ b/man/apa_beeplot.Rd @@ -46,11 +46,7 @@ apa_beeplot(data, ...) \arguments{ \item{data}{A \code{data.frame} that contains the data, or an object of class \code{afex_aov}.} -\item{...}{ - Arguments passed on to \code{\link[=apa_factorial_plot]{apa_factorial_plot}} - \describe{ - \item{\code{}}{} - }} +\item{...}{Further arguments passed on to \code{\link[=apa_factorial_plot]{apa_factorial_plot()}}.} \item{id}{Character. Variable name that identifies subjects.} diff --git a/man/apa_lineplot.Rd b/man/apa_lineplot.Rd index 15b6ee0a..128a2944 100644 --- a/man/apa_lineplot.Rd +++ b/man/apa_lineplot.Rd @@ -46,11 +46,7 @@ apa_lineplot(data, ...) \arguments{ \item{data}{A \code{data.frame} that contains the data, or an object of class \code{afex_aov}.} -\item{...}{ - Arguments passed on to \code{\link[=apa_factorial_plot]{apa_factorial_plot}} - \describe{ - \item{\code{}}{} - }} +\item{...}{Further arguments passed on to \code{\link[=apa_factorial_plot]{apa_factorial_plot()}}.} \item{id}{Character. Variable name that identifies subjects.}