diff --git a/R/check_operators.R b/R/check_operators.R index 0b8f805a..4bee28d5 100644 --- a/R/check_operators.R +++ b/R/check_operators.R @@ -4,7 +4,7 @@ #' Logical AND and OR operators for `check_*`-functions from [`checkmate`][`checkmate::checkmate`]. #' #' @param lhs,rhs (`function()`)\cr -#' `check_*`-functions that return either `TRUE` or an error message. +#' `check_*`-functions that return either `TRUE` or an error message as a `character(1)`. #' #' @return Either `TRUE` or a `character(1)`. #' @@ -12,7 +12,7 @@ #' @examples #' library(checkmate) #' -#' x = c(0, 1, 2, 3)# +#' x = c(0, 1, 2, 3) #' check_numeric(x) %check&&% check_names(names(x), "unnamed") # is TRUE #' check_numeric(x) %check&&% check_true(all(x < 0)) # fails #' diff --git a/man/check_operators.Rd b/man/check_operators.Rd index 8d3901f9..17829969 100644 --- a/man/check_operators.Rd +++ b/man/check_operators.Rd @@ -12,7 +12,7 @@ lhs \%check||\% rhs } \arguments{ \item{lhs, rhs}{(\verb{function()})\cr -\verb{check_*}-functions that return either \code{TRUE} or an error message.} +\verb{check_*}-functions that return either \code{TRUE} or an error message as a \code{character(1)}.} } \value{ Either \code{TRUE} or a \code{character(1)}. @@ -23,7 +23,7 @@ Logical AND and OR operators for \verb{check_*}-functions from \code{\link[check \examples{ library(checkmate) -x = c(0, 1, 2, 3)# +x = c(0, 1, 2, 3) check_numeric(x) \%check&&\% check_names(names(x), "unnamed") # is TRUE check_numeric(x) \%check&&\% check_true(all(x < 0)) # fails