From b5f25632cef045b48da7177eee631c8c7dd3d1c2 Mon Sep 17 00:00:00 2001 From: Maximilian Muecke Date: Fri, 13 Dec 2024 23:00:19 +0100 Subject: [PATCH] docs: more consisten type annotations --- R/anyInfinite.R | 2 +- R/anyMissing.R | 2 +- R/anyNaN.R | 2 +- R/asInteger.R | 2 +- R/assert.R | 4 ++-- R/checkCharacter.R | 2 +- R/checkNamed.R | 2 +- R/checkNames.R | 2 +- R/coalesce.R | 4 ++-- R/matchArg.R | 6 +++--- R/qassert.R | 2 +- R/vname.R | 2 +- man-roxygen/x.R | 2 +- man/anyInfinite.Rd | 2 +- man/anyMissing.Rd | 2 +- man/anyNaN.Rd | 2 +- man/asInteger.Rd | 2 +- man/assert.Rd | 2 +- man/checkAccess.Rd | 2 +- man/checkArray.Rd | 2 +- man/checkAtomic.Rd | 2 +- man/checkAtomicVector.Rd | 2 +- man/checkCharacter.Rd | 4 ++-- man/checkChoice.Rd | 2 +- man/checkClass.Rd | 2 +- man/checkComplex.Rd | 2 +- man/checkCount.Rd | 2 +- man/checkDataFrame.Rd | 2 +- man/checkDataTable.Rd | 2 +- man/checkDate.Rd | 2 +- man/checkDirectoryExists.Rd | 2 +- man/checkDisjunct.Rd | 2 +- man/checkDouble.Rd | 2 +- man/checkEnvironment.Rd | 2 +- man/checkFALSE.Rd | 2 +- man/checkFactor.Rd | 2 +- man/checkFileExists.Rd | 2 +- man/checkFlag.Rd | 2 +- man/checkFormula.Rd | 2 +- man/checkFunction.Rd | 2 +- man/checkInt.Rd | 2 +- man/checkInteger.Rd | 2 +- man/checkIntegerish.Rd | 2 +- man/checkList.Rd | 2 +- man/checkLogical.Rd | 2 +- man/checkMatrix.Rd | 2 +- man/checkMultiClass.Rd | 2 +- man/checkNamed.Rd | 4 ++-- man/checkNames.Rd | 2 +- man/checkNull.Rd | 2 +- man/checkNumber.Rd | 2 +- man/checkNumeric.Rd | 2 +- man/checkPOSIXct.Rd | 2 +- man/checkPathForOutput.Rd | 2 +- man/checkPermutation.Rd | 2 +- man/checkR6.Rd | 2 +- man/checkRaw.Rd | 2 +- man/checkScalar.Rd | 2 +- man/checkScalarNA.Rd | 2 +- man/checkSetEqual.Rd | 2 +- man/checkString.Rd | 4 ++-- man/checkSubset.Rd | 2 +- man/checkTRUE.Rd | 2 +- man/checkTibble.Rd | 2 +- man/checkVector.Rd | 2 +- man/coalesce.Rd | 4 ++-- man/makeAssertion.Rd | 2 +- man/makeExpectation.Rd | 2 +- man/matchArg.Rd | 6 +++--- man/qassert.Rd | 2 +- man/vname.Rd | 2 +- 71 files changed, 81 insertions(+), 81 deletions(-) diff --git a/R/anyInfinite.R b/R/anyInfinite.R index 8b04ce1a..26ff84a0 100644 --- a/R/anyInfinite.R +++ b/R/anyInfinite.R @@ -3,7 +3,7 @@ #' @description #' Supported are atomic types (see \code{\link[base]{is.atomic}}), lists and data frames. #' -#' @param x [\code{ANY}]\cr +#' @param x [\code{any}]\cr #' Object to check. #' @return [\code{logical(1)}] Returns \code{TRUE} if any element is \code{-Inf} or \code{Inf}. #' @useDynLib checkmate c_any_infinite diff --git a/R/anyMissing.R b/R/anyMissing.R index c87c297f..0517b965 100644 --- a/R/anyMissing.R +++ b/R/anyMissing.R @@ -11,7 +11,7 @@ #' a single non-missing observation present in the \code{data.frame}, use #' \code{all(sapply(df, allMissing))} instead. #' -#' @param x [\code{ANY}]\cr +#' @param x [\code{any}]\cr #' Object to check. #' @return [\code{logical(1)}] Returns \code{TRUE} if any (\code{anyMissing}) or all (\code{allMissing}) #' elements of \code{x} are missing (see details), \code{FALSE} otherwise. diff --git a/R/anyNaN.R b/R/anyNaN.R index 749aab81..56790e03 100644 --- a/R/anyNaN.R +++ b/R/anyNaN.R @@ -3,7 +3,7 @@ #' @description #' Supported are atomic types (see \code{\link[base]{is.atomic}}), lists and data frames. #' -#' @param x [\code{ANY}]\cr +#' @param x [\code{any}]\cr #' Object to check. #' @return [\code{logical(1)}] Returns \code{TRUE} if any element is \code{NaN}. #' @useDynLib checkmate c_any_nan diff --git a/R/asInteger.R b/R/asInteger.R index a3bce55c..25728139 100644 --- a/R/asInteger.R +++ b/R/asInteger.R @@ -13,7 +13,7 @@ #' \code{\link{assertInt}} or \code{\link{assertIntegerish}} with #' argument \code{coerce} set to \code{TRUE} instead. #' -#' @param x [any]\cr +#' @param x [\code{any}]\cr #' Object to convert. #' @template na-handling #' @inheritParams checkInteger diff --git a/R/assert.R b/R/assert.R index 73d468e8..976f473e 100644 --- a/R/assert.R +++ b/R/assert.R @@ -9,7 +9,7 @@ #' \code{combine} is \dQuote{and} and all checks evaluate to \code{TRUE}. #' Otherwise, \code{assert} throws an informative error message. #' -#' @param ... [any]\cr +#' @param ... [\code{any}]\cr #' List of calls to check functions. #' @param combine [\code{character(1)}]\cr #' \dQuote{or} or \dQuote{and} to combine the check functions with an OR @@ -62,7 +62,7 @@ assert = function(..., combine = "or", .var.name = NULL, add = NULL) { # Error handling in assert() # # Internal helper function to handle errors in assert(). -# @param res [character(1)}]\cr +# @param res [\code{character(1)}]\cr # error message # @param v_name [\code{character}]\cr # Name(s) of the variable(s) whose assertion failed. diff --git a/R/checkCharacter.R b/R/checkCharacter.R index 5afef2e4..6a1f99c9 100644 --- a/R/checkCharacter.R +++ b/R/checkCharacter.R @@ -7,7 +7,7 @@ #' @template x #' @template na-handling #' @inheritParams checkVector -#' @param pattern [\code{character(1L)}]\cr +#' @param pattern [\code{character(1)}]\cr #' Regular expression as used in \code{\link[base]{grepl}}. #' All non-missing elements of \code{x} must comply to this pattern. #' @param fixed [\code{character(1)}]\cr diff --git a/R/checkNamed.R b/R/checkNamed.R index e3fcb8c9..ec33a171 100644 --- a/R/checkNamed.R +++ b/R/checkNamed.R @@ -2,7 +2,7 @@ #' #' @templateVar fn Named #' @template x -#' @param type [character(1)]\cr +#' @param type [\code{character(1)}]\cr #' Select the check(s) to perform. #' \dQuote{unnamed} checks \code{x} to be unnamed. #' \dQuote{named} (default) checks \code{x} to be named which excludes names to be \code{NA} or empty (\code{""}). diff --git a/R/checkNames.R b/R/checkNames.R index f5942bbe..7b83ab50 100644 --- a/R/checkNames.R +++ b/R/checkNames.R @@ -6,7 +6,7 @@ #' @templateVar fn Names #' @param x [\code{character} || \code{NULL}]\cr #' Names to check using rules defined via \code{type}. -#' @param type [character(1)]\cr +#' @param type [\code{character(1)}]\cr #' Type of formal check(s) to perform on the names. #' \describe{ #' \item{unnamed:}{Checks \code{x} to be \code{NULL}.} diff --git a/R/coalesce.R b/R/coalesce.R index 13cf243a..e0c6176b 100644 --- a/R/coalesce.R +++ b/R/coalesce.R @@ -5,9 +5,9 @@ #' Returns the left hand side if not missing nor \code{NULL}, and #' the right hand side otherwise. #' -#' @param lhs [any]\cr +#' @param lhs [\code{any}]\cr #' Left hand side of the operator. Is returned if not missing or \code{NULL}. -#' @param rhs [any]\cr +#' @param rhs [\code{any}]\cr #' Right hand side of the operator. Is returned if \code{lhs} is missing or \code{NULL}. #' @return Either \code{lhs} or \code{rhs}. #' @export diff --git a/R/matchArg.R b/R/matchArg.R index 72cc7ba7..82271fdf 100644 --- a/R/matchArg.R +++ b/R/matchArg.R @@ -5,11 +5,11 @@ #' The behavior is very similar to \code{\link[base]{match.arg}}, except that \code{NULL} is not #' a valid value for \code{x}. #' -#' @param x [character]\cr +#' @param x [\code{character}]\cr #' User provided argument to match. -#' @param choices [character()]\cr +#' @param choices [\code{character}]\cr #' Candidates to match \code{x} with. -#' @param several.ok [logical(1)]\cr +#' @param several.ok [\code{logical(1)}]\cr #' If \code{TRUE}, multiple matches are allowed, cf. \code{\link[base]{match.arg}}. #' @template add #' @template var.name diff --git a/R/qassert.R b/R/qassert.R index e7aa7cab..95395d35 100644 --- a/R/qassert.R +++ b/R/qassert.R @@ -4,7 +4,7 @@ #' The provided functions parse rules which allow to express some of the most #' frequent argument checks by typing just a few letters. #' -#' @param x [any]\cr +#' @param x [\code{any}]\cr #' Object the check. #' @param rules [\code{character}]\cr #' Set of rules. See details. diff --git a/R/vname.R b/R/vname.R index d1d3a7de..0f7d6e13 100644 --- a/R/vname.R +++ b/R/vname.R @@ -3,7 +3,7 @@ #' Tries to heuristically determine the variable name of \code{x} in the parent frame #' with a combination of \code{\link[base]{deparse}} and \code{\link[base]{substitute}}. #' Used for checkmate's error messages. -#' @param x [ANY]\cr +#' @param x [\code{any}]\cr #' Object. #' @return [\code{character(1)}] Variable name. #' @export diff --git a/man-roxygen/x.R b/man-roxygen/x.R index eb38b796..a2511e99 100644 --- a/man-roxygen/x.R +++ b/man-roxygen/x.R @@ -1,2 +1,2 @@ -#' @param x [any]\cr +#' @param x [\code{any}]\cr #' Object to check. diff --git a/man/anyInfinite.Rd b/man/anyInfinite.Rd index b1dfad8f..040e4a3b 100644 --- a/man/anyInfinite.Rd +++ b/man/anyInfinite.Rd @@ -7,7 +7,7 @@ anyInfinite(x) } \arguments{ -\item{x}{[\code{ANY}]\cr +\item{x}{[\code{any}]\cr Object to check.} } \value{ diff --git a/man/anyMissing.Rd b/man/anyMissing.Rd index f4cd2624..c82a8b2b 100644 --- a/man/anyMissing.Rd +++ b/man/anyMissing.Rd @@ -10,7 +10,7 @@ allMissing(x) anyMissing(x) } \arguments{ -\item{x}{[\code{ANY}]\cr +\item{x}{[\code{any}]\cr Object to check.} } \value{ diff --git a/man/anyNaN.Rd b/man/anyNaN.Rd index 93042aaa..f432fff4 100644 --- a/man/anyNaN.Rd +++ b/man/anyNaN.Rd @@ -7,7 +7,7 @@ anyNaN(x) } \arguments{ -\item{x}{[\code{ANY}]\cr +\item{x}{[\code{any}]\cr Object to check.} } \value{ diff --git a/man/asInteger.Rd b/man/asInteger.Rd index 7e972aed..d27dd3a3 100644 --- a/man/asInteger.Rd +++ b/man/asInteger.Rd @@ -40,7 +40,7 @@ asInt( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to convert.} \item{tol}{[\code{double(1)}]\cr diff --git a/man/assert.Rd b/man/assert.Rd index 7ed070cd..cfab3bcc 100644 --- a/man/assert.Rd +++ b/man/assert.Rd @@ -7,7 +7,7 @@ assert(..., combine = "or", .var.name = NULL, add = NULL) } \arguments{ -\item{...}{[any]\cr +\item{...}{[\code{any}]\cr List of calls to check functions.} \item{combine}{[\code{character(1)}]\cr diff --git a/man/checkAccess.Rd b/man/checkAccess.Rd index ee103446..91760d74 100644 --- a/man/checkAccess.Rd +++ b/man/checkAccess.Rd @@ -25,7 +25,7 @@ test_access(x, access = "") expect_access(x, access = "", info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{access}{[\code{character(1)}]\cr diff --git a/man/checkArray.Rd b/man/checkArray.Rd index 3ca14ceb..fb3d2705 100644 --- a/man/checkArray.Rd +++ b/man/checkArray.Rd @@ -87,7 +87,7 @@ expect_array( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{mode}{[\code{character(1)}]\cr diff --git a/man/checkAtomic.Rd b/man/checkAtomic.Rd index bb92af55..352d87b5 100644 --- a/man/checkAtomic.Rd +++ b/man/checkAtomic.Rd @@ -94,7 +94,7 @@ expect_atomic( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{any.missing}{[\code{logical(1)}]\cr diff --git a/man/checkAtomicVector.Rd b/man/checkAtomicVector.Rd index 781060d3..6cc1f7ed 100644 --- a/man/checkAtomicVector.Rd +++ b/man/checkAtomicVector.Rd @@ -94,7 +94,7 @@ expect_atomic_vector( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{any.missing}{[\code{logical(1)}]\cr diff --git a/man/checkCharacter.Rd b/man/checkCharacter.Rd index 04bc63a6..9e3e1358 100644 --- a/man/checkCharacter.Rd +++ b/man/checkCharacter.Rd @@ -157,7 +157,7 @@ expect_character( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{n.chars}{[\code{integer(1)}]\cr @@ -169,7 +169,7 @@ Minimum number of characters for each element of \code{x}.} \item{max.chars}{[\code{integer(1)}]\cr Maximum number of characters for each element of \code{x}.} -\item{pattern}{[\code{character(1L)}]\cr +\item{pattern}{[\code{character(1)}]\cr Regular expression as used in \code{\link[base]{grepl}}. All non-missing elements of \code{x} must comply to this pattern.} diff --git a/man/checkChoice.Rd b/man/checkChoice.Rd index 0a83e5e2..f8a3d6fe 100644 --- a/man/checkChoice.Rd +++ b/man/checkChoice.Rd @@ -46,7 +46,7 @@ expect_choice( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{choices}{[\code{atomic}]\cr diff --git a/man/checkClass.Rd b/man/checkClass.Rd index cedf2b3f..27817aa5 100644 --- a/man/checkClass.Rd +++ b/man/checkClass.Rd @@ -46,7 +46,7 @@ expect_class( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{classes}{[\code{character}]\cr diff --git a/man/checkComplex.Rd b/man/checkComplex.Rd index ffb5b735..d8e5fed0 100644 --- a/man/checkComplex.Rd +++ b/man/checkComplex.Rd @@ -108,7 +108,7 @@ expect_complex( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{any.missing}{[\code{logical(1)}]\cr diff --git a/man/checkCount.Rd b/man/checkCount.Rd index f9750ffe..56c84552 100644 --- a/man/checkCount.Rd +++ b/man/checkCount.Rd @@ -75,7 +75,7 @@ expect_count( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{na.ok}{[\code{logical(1)}]\cr diff --git a/man/checkDataFrame.Rd b/man/checkDataFrame.Rd index a7bb9205..60b151e6 100644 --- a/man/checkDataFrame.Rd +++ b/man/checkDataFrame.Rd @@ -129,7 +129,7 @@ expect_data_frame( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{types}{[\code{character}]\cr diff --git a/man/checkDataTable.Rd b/man/checkDataTable.Rd index 4bca4497..12b71d54 100644 --- a/man/checkDataTable.Rd +++ b/man/checkDataTable.Rd @@ -143,7 +143,7 @@ expect_data_table( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{key}{[\code{character}]\cr diff --git a/man/checkDate.Rd b/man/checkDate.Rd index 3b8de355..11b63d3b 100644 --- a/man/checkDate.Rd +++ b/man/checkDate.Rd @@ -108,7 +108,7 @@ expect_date( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{lower}{[\code{\link[base]{Date}}]\cr diff --git a/man/checkDirectoryExists.Rd b/man/checkDirectoryExists.Rd index d27686e4..02850582 100644 --- a/man/checkDirectoryExists.Rd +++ b/man/checkDirectoryExists.Rd @@ -43,7 +43,7 @@ test_directory(x, access = "") expect_directory(x, access = "", info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{access}{[\code{character(1)}]\cr diff --git a/man/checkDisjunct.Rd b/man/checkDisjunct.Rd index 3c42f297..3530e16a 100644 --- a/man/checkDisjunct.Rd +++ b/man/checkDisjunct.Rd @@ -25,7 +25,7 @@ test_disjunct(x, y, fmatch = FALSE) expect_disjunct(x, y, fmatch = FALSE, info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{y}{[\code{atomic}]\cr diff --git a/man/checkDouble.Rd b/man/checkDouble.Rd index bb7a02eb..3e89d365 100644 --- a/man/checkDouble.Rd +++ b/man/checkDouble.Rd @@ -136,7 +136,7 @@ expect_double( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{lower}{[\code{numeric(1)}]\cr diff --git a/man/checkEnvironment.Rd b/man/checkEnvironment.Rd index 9e783007..4872bdaa 100644 --- a/man/checkEnvironment.Rd +++ b/man/checkEnvironment.Rd @@ -43,7 +43,7 @@ expect_environment( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{contains}{[\code{character}]\cr diff --git a/man/checkFALSE.Rd b/man/checkFALSE.Rd index 15283f4c..e665cc52 100644 --- a/man/checkFALSE.Rd +++ b/man/checkFALSE.Rd @@ -22,7 +22,7 @@ testFALSE(x, na.ok = FALSE) test_false(x, na.ok = FALSE) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{na.ok}{[\code{logical(1)}]\cr diff --git a/man/checkFactor.Rd b/man/checkFactor.Rd index e591ec05..4c0c15c1 100644 --- a/man/checkFactor.Rd +++ b/man/checkFactor.Rd @@ -143,7 +143,7 @@ expect_factor( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{levels}{[\code{character}]\cr diff --git a/man/checkFileExists.Rd b/man/checkFileExists.Rd index 01e341b4..4623271f 100644 --- a/man/checkFileExists.Rd +++ b/man/checkFileExists.Rd @@ -58,7 +58,7 @@ testFile(x, access = "", extension = NULL) expect_file(x, access = "", extension = NULL, info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{access}{[\code{character(1)}]\cr diff --git a/man/checkFlag.Rd b/man/checkFlag.Rd index acbc5b00..7fdc5c20 100644 --- a/man/checkFlag.Rd +++ b/man/checkFlag.Rd @@ -31,7 +31,7 @@ test_flag(x, na.ok = FALSE, null.ok = FALSE) expect_flag(x, na.ok = FALSE, null.ok = FALSE, info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{na.ok}{[\code{logical(1)}]\cr diff --git a/man/checkFormula.Rd b/man/checkFormula.Rd index 4bceeaa6..9b22d560 100644 --- a/man/checkFormula.Rd +++ b/man/checkFormula.Rd @@ -25,7 +25,7 @@ test_formula(x, null.ok = FALSE) expect_formula(x, null.ok = FALSE, info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{null.ok}{[\code{logical(1)}]\cr diff --git a/man/checkFunction.Rd b/man/checkFunction.Rd index bc2957dc..f5290902 100644 --- a/man/checkFunction.Rd +++ b/man/checkFunction.Rd @@ -49,7 +49,7 @@ expect_function( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{args}{[\code{character}]\cr diff --git a/man/checkInt.Rd b/man/checkInt.Rd index 7d5856ad..4b9d5fe3 100644 --- a/man/checkInt.Rd +++ b/man/checkInt.Rd @@ -82,7 +82,7 @@ expect_int( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{na.ok}{[\code{logical(1)}]\cr diff --git a/man/checkInteger.Rd b/man/checkInteger.Rd index c2a78c6c..50908155 100644 --- a/man/checkInteger.Rd +++ b/man/checkInteger.Rd @@ -129,7 +129,7 @@ expect_integer( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{lower}{[\code{numeric(1)}]\cr diff --git a/man/checkIntegerish.Rd b/man/checkIntegerish.Rd index d008adac..358c5805 100644 --- a/man/checkIntegerish.Rd +++ b/man/checkIntegerish.Rd @@ -138,7 +138,7 @@ expect_integerish( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{tol}{[\code{double(1)}]\cr diff --git a/man/checkList.Rd b/man/checkList.Rd index b3c0e9b0..57287d55 100644 --- a/man/checkList.Rd +++ b/man/checkList.Rd @@ -108,7 +108,7 @@ expect_list( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{types}{[\code{character}]\cr diff --git a/man/checkLogical.Rd b/man/checkLogical.Rd index 8f7c2cfe..b24bfa26 100644 --- a/man/checkLogical.Rd +++ b/man/checkLogical.Rd @@ -108,7 +108,7 @@ expect_logical( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{any.missing}{[\code{logical(1)}]\cr diff --git a/man/checkMatrix.Rd b/man/checkMatrix.Rd index b34a9815..cc8e87e9 100644 --- a/man/checkMatrix.Rd +++ b/man/checkMatrix.Rd @@ -129,7 +129,7 @@ expect_matrix( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{mode}{[\code{character(1)}]\cr diff --git a/man/checkMultiClass.Rd b/man/checkMultiClass.Rd index 3354ee86..fc581b00 100644 --- a/man/checkMultiClass.Rd +++ b/man/checkMultiClass.Rd @@ -31,7 +31,7 @@ test_multi_class(x, classes, null.ok = FALSE) expect_multi_class(x, classes, null.ok = FALSE, info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{classes}{[\code{character}]\cr diff --git a/man/checkNamed.Rd b/man/checkNamed.Rd index ef3dd5fe..74ef4fbc 100644 --- a/man/checkNamed.Rd +++ b/man/checkNamed.Rd @@ -22,10 +22,10 @@ testNamed(x, type = "named") test_named(x, type = "named") } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} -\item{type}{[character(1)]\cr +\item{type}{[\code{character(1)}]\cr Select the check(s) to perform. \dQuote{unnamed} checks \code{x} to be unnamed. \dQuote{named} (default) checks \code{x} to be named which excludes names to be \code{NA} or empty (\code{""}). diff --git a/man/checkNames.Rd b/man/checkNames.Rd index 9b00b833..b4f5db52 100644 --- a/man/checkNames.Rd +++ b/man/checkNames.Rd @@ -97,7 +97,7 @@ expect_names( \item{x}{[\code{character} || \code{NULL}]\cr Names to check using rules defined via \code{type}.} -\item{type}{[character(1)]\cr +\item{type}{[\code{character(1)}]\cr Type of formal check(s) to perform on the names. \describe{ \item{unnamed:}{Checks \code{x} to be \code{NULL}.} diff --git a/man/checkNull.Rd b/man/checkNull.Rd index e641c11c..8f92d471 100644 --- a/man/checkNull.Rd +++ b/man/checkNull.Rd @@ -22,7 +22,7 @@ testNull(x) test_null(x) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{.var.name}{[\code{character(1)}]\cr diff --git a/man/checkNumber.Rd b/man/checkNumber.Rd index d15757c3..422661d8 100644 --- a/man/checkNumber.Rd +++ b/man/checkNumber.Rd @@ -80,7 +80,7 @@ expect_number( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{na.ok}{[\code{logical(1)}]\cr diff --git a/man/checkNumeric.Rd b/man/checkNumeric.Rd index 917d0d72..edd8a8f8 100644 --- a/man/checkNumeric.Rd +++ b/man/checkNumeric.Rd @@ -136,7 +136,7 @@ expect_numeric( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{lower}{[\code{numeric(1)}]\cr diff --git a/man/checkPOSIXct.Rd b/man/checkPOSIXct.Rd index 3d16589f..7578bb37 100644 --- a/man/checkPOSIXct.Rd +++ b/man/checkPOSIXct.Rd @@ -115,7 +115,7 @@ expect_posixct( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{lower}{[\code{\link[base]{Date}}]\cr diff --git a/man/checkPathForOutput.Rd b/man/checkPathForOutput.Rd index 2088f7ea..6a29255a 100644 --- a/man/checkPathForOutput.Rd +++ b/man/checkPathForOutput.Rd @@ -43,7 +43,7 @@ expect_path_for_output( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{overwrite}{[\code{logical(1)}]\cr diff --git a/man/checkPermutation.Rd b/man/checkPermutation.Rd index 2279fcdf..36b8e0ef 100644 --- a/man/checkPermutation.Rd +++ b/man/checkPermutation.Rd @@ -25,7 +25,7 @@ test_permutation(x, y, na.ok = TRUE) expect_permutation(x, y, na.ok = TRUE, info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{y}{[\code{atomic}]\cr diff --git a/man/checkR6.Rd b/man/checkR6.Rd index 93f54351..4b2ecef6 100644 --- a/man/checkR6.Rd +++ b/man/checkR6.Rd @@ -87,7 +87,7 @@ expect_r6( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{classes}{[\code{character}]\cr diff --git a/man/checkRaw.Rd b/man/checkRaw.Rd index 70911f7b..ea8e6bee 100644 --- a/man/checkRaw.Rd +++ b/man/checkRaw.Rd @@ -80,7 +80,7 @@ expect_raw( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{len}{[\code{integer(1)}]\cr diff --git a/man/checkScalar.Rd b/man/checkScalar.Rd index 78554ce0..89badb18 100644 --- a/man/checkScalar.Rd +++ b/man/checkScalar.Rd @@ -37,7 +37,7 @@ test_scalar(x, na.ok = FALSE, null.ok = FALSE) expect_scalar(x, na.ok = FALSE, null.ok = FALSE, info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{na.ok}{[\code{logical(1)}]\cr diff --git a/man/checkScalarNA.Rd b/man/checkScalarNA.Rd index 48242728..186e5004 100644 --- a/man/checkScalarNA.Rd +++ b/man/checkScalarNA.Rd @@ -25,7 +25,7 @@ test_scalar_na(x, null.ok = FALSE) expect_scalar_na(x, null.ok = FALSE, info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{null.ok}{[\code{logical(1)}]\cr diff --git a/man/checkSetEqual.Rd b/man/checkSetEqual.Rd index dd10302a..0f9fa02e 100644 --- a/man/checkSetEqual.Rd +++ b/man/checkSetEqual.Rd @@ -46,7 +46,7 @@ expect_set_equal( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{y}{[\code{atomic}]\cr diff --git a/man/checkString.Rd b/man/checkString.Rd index ce258e1c..5e55418e 100644 --- a/man/checkString.Rd +++ b/man/checkString.Rd @@ -101,7 +101,7 @@ expect_string( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{na.ok}{[\code{logical(1)}]\cr @@ -116,7 +116,7 @@ Minimum number of characters for each element of \code{x}.} \item{max.chars}{[\code{integer(1)}]\cr Maximum number of characters for each element of \code{x}.} -\item{pattern}{[\code{character(1L)}]\cr +\item{pattern}{[\code{character(1)}]\cr Regular expression as used in \code{\link[base]{grepl}}. All non-missing elements of \code{x} must comply to this pattern.} diff --git a/man/checkSubset.Rd b/man/checkSubset.Rd index bbb9b402..0784fea6 100644 --- a/man/checkSubset.Rd +++ b/man/checkSubset.Rd @@ -46,7 +46,7 @@ expect_subset( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{choices}{[\code{atomic}]\cr diff --git a/man/checkTRUE.Rd b/man/checkTRUE.Rd index edf3ef82..111311ab 100644 --- a/man/checkTRUE.Rd +++ b/man/checkTRUE.Rd @@ -22,7 +22,7 @@ testTRUE(x, na.ok = FALSE) test_true(x, na.ok = FALSE) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{na.ok}{[\code{logical(1)}]\cr diff --git a/man/checkTibble.Rd b/man/checkTibble.Rd index 0aefe4e5..0a13c2dc 100644 --- a/man/checkTibble.Rd +++ b/man/checkTibble.Rd @@ -129,7 +129,7 @@ expect_tibble( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{types}{[\code{character}]\cr diff --git a/man/checkVector.Rd b/man/checkVector.Rd index cb626349..8315dff4 100644 --- a/man/checkVector.Rd +++ b/man/checkVector.Rd @@ -92,7 +92,7 @@ test_vector( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{strict}{[\code{logical(1)}]\cr diff --git a/man/coalesce.Rd b/man/coalesce.Rd index c1aec328..232f0790 100644 --- a/man/coalesce.Rd +++ b/man/coalesce.Rd @@ -7,10 +7,10 @@ lhs \%??\% rhs } \arguments{ -\item{lhs}{[any]\cr +\item{lhs}{[\code{any}]\cr Left hand side of the operator. Is returned if not missing or \code{NULL}.} -\item{rhs}{[any]\cr +\item{rhs}{[\code{any}]\cr Right hand side of the operator. Is returned if \code{lhs} is missing or \code{NULL}.} } \value{ diff --git a/man/makeAssertion.Rd b/man/makeAssertion.Rd index 46119fc4..ffe00e90 100644 --- a/man/makeAssertion.Rd +++ b/man/makeAssertion.Rd @@ -16,7 +16,7 @@ makeAssertionFunction( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{res}{[\code{TRUE} | \code{character(1)}]\cr diff --git a/man/makeExpectation.Rd b/man/makeExpectation.Rd index 566e87b1..3012efe7 100644 --- a/man/makeExpectation.Rd +++ b/man/makeExpectation.Rd @@ -15,7 +15,7 @@ makeExpectationFunction( ) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object to check.} \item{res}{[\code{TRUE} | \code{character(1)}]\cr diff --git a/man/matchArg.Rd b/man/matchArg.Rd index c10636e1..e155698b 100644 --- a/man/matchArg.Rd +++ b/man/matchArg.Rd @@ -7,13 +7,13 @@ matchArg(x, choices, several.ok = FALSE, .var.name = vname(x), add = NULL) } \arguments{ -\item{x}{[character]\cr +\item{x}{[\code{character}]\cr User provided argument to match.} -\item{choices}{[character()]\cr +\item{choices}{[\code{character}]\cr Candidates to match \code{x} with.} -\item{several.ok}{[logical(1)]\cr +\item{several.ok}{[\code{logical(1)}]\cr If \code{TRUE}, multiple matches are allowed, cf. \code{\link[base]{match.arg}}.} \item{.var.name}{[\code{character(1)}]\cr diff --git a/man/qassert.Rd b/man/qassert.Rd index 056ca6af..d3868fe0 100644 --- a/man/qassert.Rd +++ b/man/qassert.Rd @@ -13,7 +13,7 @@ qtest(x, rules) qexpect(x, rules, info = NULL, label = vname(x)) } \arguments{ -\item{x}{[any]\cr +\item{x}{[\code{any}]\cr Object the check.} \item{rules}{[\code{character}]\cr diff --git a/man/vname.Rd b/man/vname.Rd index 9925c5e9..34b332f3 100644 --- a/man/vname.Rd +++ b/man/vname.Rd @@ -7,7 +7,7 @@ vname(x) } \arguments{ -\item{x}{[ANY]\cr +\item{x}{[\code{any}]\cr Object.} } \value{