Review and improve documentation

[hsloot]

Related issues

None

Checklist

• [x] R CMD CHECK successful
• [x] tests included
• [x] documentation included or updated
• [x] commit messages follow commit guidelines

Optional, but recommended:

• [x] code passes lintr::lint_package() without errors

Description

Proposed changes:

• Revise and improve documentation

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.78%. Comparing base (188b25a) to head (d811211).

:exclamation: Current head d811211 differs from pull request most recent head 1af3ebf. Consider uploading reports for the commit 1af3ebf to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #116 +/- ## ========================================== - Coverage 95.85% 95.78% -0.08% ========================================== Files 55 55 Lines 1399 1399 ========================================== - Hits 1341 1340 -1 - Misses 58 59 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.