man-roxygen/is_predicate.R

In biodatacore/biodatacoreUtils: Utilities for 'biodatacore' Packages

#' @family predicates
#'
#' @param x object to be checked
#' @param n scalar whole number: expected length of vector
#' @param na_rm scalar logical: whether or not NAs should be considered in the
#'   calculation. If na_rm = FALSE, then any NA in the vector being checked will
#'   result in an NA output.
#' @section Ignoring NAs
#' @return scalar logical