insightsengineering / insightsengineering/teal.data

[Feature Request]: should `verify()` return a object?

Open
#368 4 comments 0 reactions 0 assignees View on GitHub
core enhancement
Dominant language
R
Stars
11
Forks
9
PR merge metrics
No merged PRs in 30d

Description

### Feature description

I have a problem with understanding the following:
```
data <- ...
data <- verify(data)
...
```
For me, the `verify()` should be more similar to the _assert_ like below:
```
data <- ...
verify(data)
...
```

With this, we should probably modify `verify()` so that it does not return if there is no error.

Ideally, we should have `assert()` that raises error or silently pass and `check()` that returns boolean. I just can't fit the current implementation of `verify()` that throws or pass the object. WDYT?

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct.

### Contribution Guidelines

- [x] I agree to follow this project's Contribution Guidelines.

### Security Policy

- [x] I agree to follow this project's Security Policy.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.