pkgdown changes

Author: LJ-Jenkins

R/deprecate-if_not.r

@@ -261,6 +261,7 @@ abort_dispatch <- function(..., .fn, .message, .error_call, .caller_fn) {
 #' x <- y <- 1L
 #' cast_if_not(x = double(), y = character()) |> try()
 #' class(x) # integer
+#' @keywords internal
 #' @export
 cast_if_not <- function(
   ...,
@@ -436,6 +437,7 @@ cast_if_not <- function(
 #' x <- y <- 1L
 #' recycle_if_not(x = 5, y = -5) |> try()
 #' length(x) # 1
+#' @keywords internal
 #' @export
 recycle_if_not <- function(
   ...,

R/favr-package.r

@@ -3,6 +3,7 @@
 #' @import vctrs
 #' @import tidyselect
 #' @import lifecycle
+#' @keywords internal
 "_PACKAGE"
 
 on_load(

R/modifiers.r

@@ -1,4 +1,4 @@
-#' Modify behaviour of check functions
+#' Modify the behaviour of type checking functions
 #'
 #' @description
 #' Modify the type-checking, or length-checking behaviour of [favr]

README.Rmd

@@ -13,7 +13,7 @@ knitr::opts_chunk$set(
 )
 ```
 
-# favr <img id="logo" src="man/figures/logo.png" align="right" height="250" />
+# favr <img id="logo" src="man/figures/logo.png" align="right" height="250" style="float:right; height:250px" />
 
 <!-- badges: start -->
 [![CRAN status](https://www.r-pkg.org/badges/version/favr)](https://CRAN.R-project.org/package=favr)

README.md

@@ -1,7 +1,7 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# favr <img id="logo" src="man/figures/logo.png" align="right" height="250" />
+# favr <img id="logo" src="man/figures/logo.png" align="right" height="250" style="float:right; height:250px" />
 
 <!-- badges: start -->
 

_pkgdown.yml

@@ -4,77 +4,88 @@ template:
 
 reference:
 
-- title: Function Argument Validation
+- title: General validation
   desc: >
-    Tools for validation and safe casting and recycling.
+    Tools for general validation depending on input.
   contents:
-  - abort_if_not
-  - cast_if_not
-  - recycle_if_not
-  - enforce
-  - schema
+  - abortifnot
+  - abortif
+  - check
+  - check_with
+  - walk_check
+  - check_inherits
+  - check_class
 
-- title: rlang predicate wrappers
+- title: Specific validation
   desc: >
-    Wrappers around rlang predicates that enable multiple inputs.
+    Strongly typed validation.
 
-- subtitle: Attributes
+- subtitle: Types
   contents:
-  - are_named
-  - have_names
+  - check_list
+  - check_atomic
+  - check_vector
+  - check_integer
+  - check_double
+  - check_numeric
+  - check_character
+  - check_logical
+  - check_complex
+  - check_raw
+  - check_bytes
+  - check_null
+  - check_array
+  - check_matrix
+  - check_table
+  - check_factor
+  - check_ordered
+  - check_date
+  - check_posixct
+  - check_posixlt
+  - check_data_frame
+  - check_tibble
+  - check_data_table
+  - check_tidytable
+  - check_vctr
+  - check_list_of
+  - check_scalar_list
+  - check_scalar_atomic
+  - check_scalar_vector
+  - check_scalar_integer
+  - check_scalar_double
+  - check_scalar_numeric
+  - check_scalar_character
+  - check_scalar_logical
+  - check_scalar_complex
+  - check_scalar_raw
+  - check_scalar_bytes
 
-- subtitle: Type predicates
+- subtitle: Values
   contents:
-  - are_list
-  - are_atomic
-  - are_vector
-  - are_integer
-  - are_double
-  - are_complex
-  - are_character
-  - are_logical
-  - are_raw
-  - are_bytes
-  - are_null
+  - check_true
+  - check_false
+  - check_bool
+  - check_string
+  - check_no_na
+  - check_finite
+  - check_nzchar
 
-- subtitle: Scalar type predicates
+- subtitle: Modifiers
   contents:
-  - are_scalar_list
-  - are_scalar_atomic
-  - are_scalar_vector
-  - are_scalar_integer
-  - are_scalar_double
-  - are_scalar_complex
-  - are_scalar_character
-  - are_string
-  - are_scalar_logical
-  - are_bool
-  - are_scalar_raw
-  - are_scalar_bytes
+  - bare
+  - at_least
+  - at_most
+  - in_range
 
-- subtitle: Bare type predicates
+- subtitle: File system
   contents:
-  - are_bare_list
-  - are_bare_atomic
-  - are_bare_vector
-  - are_bare_integer
-  - are_bare_double
-  - are_bare_complex
-  - are_bare_character
-  - are_bare_string
-  - are_bare_logical
-  - are_bare_raw
-  - are_bare_bytes
-  - are_bare_numeric
+  - check_dir
+  - check_file
+  - check_ext
 
-- subtitle: Integerish predicates
-  contents:
-  - are_integerish
-  - are_scalar_integerish
-  - are_bare_integerish
-
-- subtitle: Utility predicates
+- title: Check builders
+  desc: >
+    Tools to build checks in the style of favr.
   contents:
-  - are_empty
-  - are_true
-  - are_false
+  - s3_vec_check
+  - s3_df_check