From d4c8b002e4c3d8e120dafca8f225873613316516 Mon Sep 17 00:00:00 2001 From: Stu Field Date: Tue, 19 Sep 2023 09:25:19 -0600 Subject: [PATCH] Minor documentation tweak to boxplotSubarray() --- R/boxplotSubarray.R | 6 +++--- man/boxplotSubarray.Rd | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/boxplotSubarray.R b/R/boxplotSubarray.R index 755ebd2..351d55d 100644 --- a/R/boxplotSubarray.R +++ b/R/boxplotSubarray.R @@ -9,13 +9,13 @@ #' [read_adat()]. #' @param color.by A column name to color the subarrays by. Typically a meta #' data field in the adat such as `SlideId`. -#' @param labels Character. A column name of `adat` used to label each box. +#' @param labels Character. A column name of `.data` used to label each box. #' @param do.log Logical. Should the data should be log10-transformed? #' @param y.lim Numeric. Length 2. The upper- and lower-quantiles of the #' _total_ data used to determine the y-axis limits of the plot. #' If `NULL`, all points are shown. -#' @param apts An optional subset of analytes (as `AptNames`) to add on top -#' of subarray boxplot. +#' @param apts Optional. A subset of analytes (as `AptNames`) to add as points +#' on top of the subarray boxplot. #' @author Stu Field #' @seealso [geom_boxplot()] #' @examples diff --git a/man/boxplotSubarray.Rd b/man/boxplotSubarray.Rd index 60f8c1e..0e19927 100644 --- a/man/boxplotSubarray.Rd +++ b/man/boxplotSubarray.Rd @@ -20,7 +20,7 @@ boxplotSubarray( \item{color.by}{A column name to color the subarrays by. Typically a meta data field in the adat such as \code{SlideId}.} -\item{labels}{Character. A column name of \code{adat} used to label each box.} +\item{labels}{Character. A column name of \code{.data} used to label each box.} \item{y.lim}{Numeric. Length 2. The upper- and lower-quantiles of the \emph{total} data used to determine the y-axis limits of the plot. @@ -28,8 +28,8 @@ If \code{NULL}, all points are shown.} \item{do.log}{Logical. Should the data should be log10-transformed?} -\item{apts}{An optional subset of analytes (as \code{AptNames}) to add on top -of subarray boxplot.} +\item{apts}{Optional. A subset of analytes (as \code{AptNames}) to add as points +on top of the subarray boxplot.} } \description{ Plots the distribution of of all analytes stratified