note updates 2

Author: LJ-Jenkins

R/abort_if_not.r

@@ -1,10 +1,10 @@
 #' Ensure the truth of R expressions
 #'
-#' If any of the expressions in `...` are not all `TRUE`, [rlang::abort] is
+#' If any of the expressions in `...` are not all `TRUE`, [abort][rlang::abort] is
 #' called for the first expression which was not ([all]) `TRUE`. The names
 #' of expressions can be used as the error message or a single default error
 #' message can be given using `.message`. Both are passed to
-#' [cli::format_inline] for formatting.
+#' [format_inline][cli::format_inline] for formatting.
 #'
 #' @param ... any number of R expressions, which should each evaluate to
 #' (a logical vector of [all]) `TRUE` for no error to occur. Positive numbers
@@ -13,7 +13,7 @@
 #' will be used in the error message.
 #' @param .message single default error message for non-named expressions.
 #' @param .error_call the call environment to use for error messages
-#' (passed to [rlang::abort]).
+#' (passed to [abort][rlang::abort]).
 #' @return NULL, called for side effects only.
 #' @details [favr::abort_if] is the opposite of [favr::abort_if_not],
 #' i.e. expressions should evaluate to ([all]) `FALSE` for no error to

R/are_attr.r

@@ -2,9 +2,9 @@
 #'
 #' @description
 #'
-#' Wrappers around [rlang] predicates that allow multiple
+#' Wrappers around [rlang][rlang::rlang-package] predicates that allow multiple
 #' objects to be passed. The following documentation is adapted
-#' from the [rlang] documentation:
+#' from the rlang [documentation][rlang::is_named]:
 #'
 #' * `are_named()` is a scalar predicate that checks that objects in `...`
 #'    have a `names` attribute and that none of the names are missing or empty
@@ -13,7 +13,7 @@
 #' * `are_named2()` is like `are_named()` but always returns `TRUE` for
 #'   empty vectors, even those that don't have a `names` attribute.
 #'   In other words, it tests for the property that each element of a
-#'   vector is named. `are_named2()` composes well with [names2()]
+#'   vector is named. `are_named2()` composes well with `names2()`
 #'   whereas `are_named()` composes with `names()`.
 #'
 #' * `have_names()` is a vectorised variant.

R/are_types.r

@@ -2,8 +2,8 @@
 #'
 #' @description
 #'
-#' Wrappers around [rlang][rlang-package] type predicates that allow multiple
-#' objects to be passed. The following documentation is adapted
+#' Wrappers around [rlang][rlang::rlang-package] type predicates that
+#' allow multiple objects to be passed. The following documentation is adapted
 #' from the rlang [documentation][rlang::type-predicates]:
 #'
 #' These type predicates aim to make type testing in R more
@@ -151,8 +151,8 @@ are_null <- function(..., .all = FALSE) {
 #'
 #' @description
 #'
-#' Wrappers around [rlang][rlang-package] scalar type predicates that allow
-#' multiple objects to be passed. The following documentation is adapted
+#' Wrappers around [rlang][rlang::rlang-package] scalar type predicates that
+#' allow multiple objects to be passed. The following documentation is adapted
 #' from the rlang [documentation][rlang::scalar-type-predicates]:
 #'
 #' These predicates check for a given type and whether the vector is
@@ -286,8 +286,8 @@ are_scalar_bytes <- function(..., .all = FALSE) {
 #'
 #' @description
 #'
-#' Wrappers around [rlang][rlang-package] type predicates that allow multiple
-#' objects to be passed. The following documentation is adapted
+#' Wrappers around [rlang][rlang::rlang-package] type predicates that
+#' allow multiple objects to be passed. The following documentation is adapted
 #' from the rlang [documentation][rlang::bare-type-predicates]:
 #'
 #' These predicates check for a given type but only return `TRUE` for
@@ -421,7 +421,7 @@ are_bare_numeric <- function(..., .n = NULL, .all = FALSE) {
 #' @param ... Objects to be tested.
 #' @param .all Whether to return if all arguments are TRUE.
 #' @inherit are-type-predicates return
-#' @seealso [is_empty]
+#' @seealso [is_empty][rlang::is_empty]
 #' @examples
 #' x <- 1
 #' y <- NULL
@@ -475,7 +475,7 @@ are_false <- function(..., .all = FALSE) {
 #'
 #' @description
 #'
-#' Wrappers around [rlang][rlang-package] type predicates that allow
+#' Wrappers around [rlang][rlang::rlang-package] type predicates that allow
 #' multiple objects to be passed. The following documentation is adapted
 #' from the rlang [documentation][rlang::is_integerish]:
 #'

R/cast_if_not.r

@@ -14,7 +14,7 @@
 #' @param .env the environment to use for the evaluation of the casting
 #' expressions and the assignment of the casted objects.
 #' @param .error_call the call environment to use for error messages
-#' (passed to [rlang::abort]).
+#' (passed to [abort][rlang::abort]).
 #' @return NULL, but objects named in `...` will be changed in the
 #' `.env` environment specified.
 #' @details See [favr::abort_if_not] for general validation,

R/enforce.r

@@ -1,8 +1,8 @@
 #' Ensure the truth of R expressions and cast/recycle objects.
 #'
-#' If any of the expressions in `...` are not all `TRUE`, [rlang::abort]
+#' If any of the expressions in `...` are not all `TRUE`, [abort][rlang::abort]
 #' is called for the first which was not ([all]) `TRUE`. Alternatively,
-#' [rlang::formulas](https://rlang.r-lib.org/reference/new_formula.html) can
+#' [rlang formulas](https://rlang.r-lib.org/reference/new_formula.html) can
 #' be used to pass multiple objects to validation formulas/functions,
 #' and/or attempt safe type casting and size recycling  using the
 #' [favr::cast], [favr::recycle] and [favr::coerce] functions. The rhs of
@@ -19,11 +19,11 @@
 #' [favr::coerce] on the rhs. The rhs of a formula can also be a [list]
 #' of multiple functions/formulas/calls. If an expression is named, or
 #' if the list element on the rhs of a formula is named, the name is passed to
-#' [cli::format_inline] and is used in the error message.
+#' [format_inline][cli::format_inline] and is used in the error message.
 #' @param .env the environment to use for the evaluation of the
 #' expressions and the assignment of the objects.
 #' @param .error_call the call environment to use for error messages
-#' (passed to [rlang::abort]).
+#' (passed to [abort][rlang::abort]).
 #' @return NULL, but objects casted/recycled in `...` will be changed in
 #' the `.env` environment specified.
 #' @details See [favr::abort_if_not] for only validations and

R/recycle_if_not.r

@@ -13,7 +13,7 @@
 #' @param .env the environment to use for the evaluation of the recycling
 #' expressions and the assignment of the recycled objects.
 #' @param .error_call the call environment to use for error messages
-#' (passed to [rlang::abort]).
+#' (passed to [abort][rlang::abort]).
 #' @return NULL, but objects named in `...` will be changed in the
 #' `.env` environment specified.
 #' @details See [favr::abort_if_not] for general validation,

R/schema.r

@@ -2,9 +2,9 @@
 #' elements.
 #'
 #' If any of the expressions in `...`, evaluated within the data mask
-#' `data` (see [rlang::args_data_masking]), are not all `TRUE`, [rlang::abort]
+#' `'data'` (see [data masking][rlang::args_data_masking]), are not all `TRUE`, [abort][rlang::abort]
 #' is called for the first which was not ([all]) `TRUE`. Alternatively,
-#' [rlang::formulas](https://rlang.r-lib.org/reference/new_formula.html) can
+#' [rlang formulas](https://rlang.r-lib.org/reference/new_formula.html) can
 #' be used to take advantage of [tidyselect](https://tidyselect.r-lib.org/index.html)
 #' features and pass multiple named elements in `data` to validation
 #' formulas/functions, and/or attempt safe type casting and size recycling
@@ -18,19 +18,19 @@
 #'
 #' @param data a data.frame or list to use as the data mask.
 #' @param ... any number of R expressions or formulas to be evaluated using
-#' `data` as a data mask. Formulas can use [tidyselect] syntax
+#' `data` as a data mask. Formulas can use tidyselect syntax
 #' on the lhs and either functions or formulas that evaluate to logical, or one
 #' of the type/size functions: [favr::cast], [favr::recycle] and [favr::coerce]
 #' on the rhs. The rhs of a formula can also be a [list] of multiple
 #' functions/formulas/calls. If an expression is named, or if the list
 #' element on the rhs of a formula is named, the name is passed to
-#' [cli::format_inline] and is used in the error message.
+#' [format_inline][cli::format_inline] and is used in the error message.
 #' @param .names character vector of names which must be present in the `data`
 #' data.frame/list.
 #' @param .size positive scalar integerish value for the size that the `data`
 #' data.frame/list must be.
 #' @param .error_call the call environment to use for error messages
-#' (passed to [rlang::abort]).
+#' (passed to [abort][rlang::abort]).
 #' @param .darg the argument name of `data` to use in error messages.
 #' @return `data` is returned with attached class `with_schema` and
 #' attribute `schema` containing the schema call to be enforced later.