diff --git a/NAMESPACE b/NAMESPACE index 3f80daa..ca9071c 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -2,7 +2,10 @@ export(check_container_class) export(check_envvar) +export(check_nzchar) +export(check_scalar_type) export(check_that) +export(check_vec) export(generate_resource) export(get_auth_token) export(get_container) diff --git a/R/azkit_helpers.R b/R/helpers.R similarity index 98% rename from R/azkit_helpers.R rename to R/helpers.R index 550bca7..c5d5b88 100644 --- a/R/azkit_helpers.R +++ b/R/helpers.R @@ -46,7 +46,7 @@ ct_error_msg <- \(text) paste0("{.fn check_that}: ", text) #' predicate. "some" is unlikely to be useful often, but it is available. #' @inheritParams check_that #' @seealso [check_scalar_type()] -#' @keywords internal +#' @export check_vec <- function( x, predicate, @@ -78,7 +78,7 @@ cv_error_msg <- \(text) paste0("{.fn check_vec}: ", text) #' @seealso [check_that] #' @inheritParams check_that #' @param type A string defining the R object type that `x` is checked to be -#' @keywords internal +#' @export check_scalar_type <- function( x, type, @@ -122,7 +122,7 @@ cst_error_msg <- \(text) paste0("{.fn check_scalar_type}: ", text) #' semantic markup. Variable values will be searched for in the environment of #' the caller function (not in the environment of `check_nzchar()`). This #' makes it easier to include informative values in the message. -#' @keywords internal +#' @export check_nzchar <- function(x, message, pf = parent.frame()) { if (is.null(x)) { NULL diff --git a/man/check_container_class.Rd b/man/check_container_class.Rd index 1d3c3ec..9d581a0 100644 --- a/man/check_container_class.Rd +++ b/man/check_container_class.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/azkit_helpers.R +% Please edit documentation in R/helpers.R \name{check_container_class} \alias{check_container_class} \title{Check that a container looks like a real container} diff --git a/man/check_nzchar.Rd b/man/check_nzchar.Rd index 72ae9b6..25deed0 100644 --- a/man/check_nzchar.Rd +++ b/man/check_nzchar.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/azkit_helpers.R +% Please edit documentation in R/helpers.R \name{check_nzchar} \alias{check_nzchar} \title{Check if a supplied non-NULL value is a string with >0 characters} @@ -22,4 +22,3 @@ be used in the custom error message.} Will error if x is equal to \code{""}, or if it is otherwise missing or invalid. With the exception that if x is NULL, then NULL will be passed through. } -\keyword{internal} diff --git a/man/check_scalar_type.Rd b/man/check_scalar_type.Rd index 7b44f15..9bd9172 100644 --- a/man/check_scalar_type.Rd +++ b/man/check_scalar_type.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/azkit_helpers.R +% Please edit documentation in R/helpers.R \name{check_scalar_type} \alias{check_scalar_type} \title{An alternative to stopifnot/assert_that etc} @@ -28,4 +28,3 @@ Possible values for the \code{type} parameter are: "character", "logical", "list \seealso{ \link{check_that} } -\keyword{internal} diff --git a/man/check_that.Rd b/man/check_that.Rd index 9140faf..64ba285 100644 --- a/man/check_that.Rd +++ b/man/check_that.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/azkit_helpers.R +% Please edit documentation in R/helpers.R \name{check_that} \alias{check_that} \title{An alternative to stopifnot/assert_that etc} diff --git a/man/check_vec.Rd b/man/check_vec.Rd index 4663939..5d79e03 100644 --- a/man/check_vec.Rd +++ b/man/check_vec.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/azkit_helpers.R +% Please edit documentation in R/helpers.R \name{check_vec} \alias{check_vec} \title{An alternative to stopifnot/assert_that etc} @@ -43,4 +43,3 @@ element-wise, so will potentially return \code{TRUE} even if \code{length(x) > 1 \seealso{ \code{\link[=check_scalar_type]{check_scalar_type()}} } -\keyword{internal} diff --git a/man/gregg.Rd b/man/gregg.Rd index 53288ab..d2a375a 100644 --- a/man/gregg.Rd +++ b/man/gregg.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/azkit_helpers.R +% Please edit documentation in R/helpers.R \name{gregg} \alias{gregg} \title{grepl a glued regex}