Skip to content

Commit 63dfbea

Browse files
committed
Deploying to gh-pages from @ 0024213 🚀
1 parent 8afe79a commit 63dfbea

36 files changed

Lines changed: 386 additions & 2 deletions

index.html

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,15 @@ Validate specific S3 types:
5454
[`check_list_of()`](https://lj-jenkins.github.io/favr/reference/s3-type-checks.md)
5555
for their respective [vctrs](https://vctrs.r-lib.org) classes.
5656

57+
Validate OOP types:
58+
59+
- [`check_s3()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md),
60+
[`check_s4()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md),
61+
[`check_s7()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
62+
and
63+
[`check_r6()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
64+
for their respective OOP types.
65+
5766
Modify the behaviour of type-checking functions:
5867

5968
- [`bare()`](https://lj-jenkins.github.io/favr/reference/modifiers.md)
@@ -234,8 +243,12 @@ check_integer(x)
234243
check_scalar_double(x)
235244
#> Error:
236245
#> ! `x` must be a scalar <double>, but it is of length 3.
246+
check_s3(x)
247+
#> Error:
248+
#> ! `x` must be an <S3> object, not <numeric>.
237249

238250
df <- data.frame(x = 1:3, y = 1:3)
251+
check_s3(df)
239252
check_tibble(df)
240253
#> Error:
241254
#> ! `df` must inherit from <tbl_df>, but is class <data.frame>.

llms.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,15 @@ Validate specific S3 types:
5454
[`check_list_of()`](https://lj-jenkins.github.io/favr/reference/s3-type-checks.md)
5555
for their respective [vctrs](https://vctrs.r-lib.org) classes.
5656

57+
Validate OOP types:
58+
59+
- [`check_s3()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md),
60+
[`check_s4()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md),
61+
[`check_s7()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
62+
and
63+
[`check_r6()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
64+
for their respective OOP types.
65+
5766
Modify the behaviour of type-checking functions:
5867

5968
- [`bare()`](https://lj-jenkins.github.io/favr/reference/modifiers.md)
@@ -234,8 +243,12 @@ check_integer(x)
234243
check_scalar_double(x)
235244
#> Error:
236245
#> ! `x` must be a scalar <double>, but it is of length 3.
246+
check_s3(x)
247+
#> Error:
248+
#> ! `x` must be an <S3> object, not <numeric>.
237249

238250
df <- data.frame(x = 1:3, y = 1:3)
251+
check_s3(df)
239252
check_tibble(df)
240253
#> Error:
241254
#> ! `df` must inherit from <tbl_df>, but is class <data.frame>.
@@ -499,6 +512,11 @@ Strongly typed validation.
499512
[`check_scalar_bytes()`](https://lj-jenkins.github.io/favr/reference/scalar-type-checks.md)
500513
[`check_scalar_numeric()`](https://lj-jenkins.github.io/favr/reference/scalar-type-checks.md)
501514
: Scalar type checks
515+
- [`check_s3()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
516+
[`check_s4()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
517+
[`check_s7()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
518+
[`check_r6()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
519+
: Check if an object is of a specific object-oriented programming type
502520

503521
### Values
504522

news/index.html

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

news/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,16 @@ Refactor of the package to focus on function argument validation through
7373
functions to check if an object is an array, matrix, or table,
7474
respectively, and error if it is not.
7575

76+
#### OOP Type Validation
77+
78+
- [`check_s3()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md),
79+
[`check_s4()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md),
80+
[`check_s7()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
81+
and
82+
[`check_r6()`](https://lj-jenkins.github.io/favr/reference/oop-checks.md)
83+
functions to check if an object is of the specified OOP type and error
84+
if it is not.
85+
7686
#### S3 Type Validation
7787

7888
- [`check_factor()`](https://lj-jenkins.github.io/favr/reference/s3-type-checks.md),

pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ pandoc: 3.8.3
22
pkgdown: 2.2.1
33
pkgdown_sha: ~
44
articles: {}
5-
last_built: 2026-08-18T12:23Z
5+
last_built: 2026-08-18T13:01Z
66
urls:
77
reference: https://lj-jenkins.github.io/favr/reference
88
article: https://lj-jenkins.github.io/favr/articles

reference/array-type-checks.html

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

reference/array-type-checks.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ These check functions are wrappers of their corresponding base functions
109109
Other checks:
110110
[`forbidden-value-checks`](https://lj-jenkins.github.io/favr/reference/forbidden-value-checks.md),
111111
[`inheritance-checks`](https://lj-jenkins.github.io/favr/reference/inheritance-checks.md),
112+
[`oop-checks`](https://lj-jenkins.github.io/favr/reference/oop-checks.md),
112113
[`path-checks`](https://lj-jenkins.github.io/favr/reference/path-checks.md),
113114
[`property-checks`](https://lj-jenkins.github.io/favr/reference/property-checks.md),
114115
[`s3-type-checks`](https://lj-jenkins.github.io/favr/reference/s3-type-checks.md),

reference/check_r6.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<html>
2+
<head>
3+
<meta http-equiv="refresh" content="0;URL=https://lj-jenkins.github.io/favr/reference/oop-checks.html" />
4+
<meta name="robots" content="noindex">
5+
<link rel="canonical" href="https://lj-jenkins.github.io/favr/reference/oop-checks.html">
6+
</head>
7+
</html>
8+

reference/check_s3.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<html>
2+
<head>
3+
<meta http-equiv="refresh" content="0;URL=https://lj-jenkins.github.io/favr/reference/oop-checks.html" />
4+
<meta name="robots" content="noindex">
5+
<link rel="canonical" href="https://lj-jenkins.github.io/favr/reference/oop-checks.html">
6+
</head>
7+
</html>
8+

0 commit comments

Comments
 (0)