Package: doctest 0.3.0
doctest: Generate Tests from Examples Using 'roxygen' and 'testthat'
Creates 'testthat' tests from 'roxygen' examples using simple tags.
Authors:
doctest_0.3.0.tar.gz
doctest_0.3.0.zip(r-4.5)doctest_0.3.0.zip(r-4.4)doctest_0.3.0.zip(r-4.3)
doctest_0.3.0.tgz(r-4.4-any)doctest_0.3.0.tgz(r-4.3-any)
doctest_0.3.0.tar.gz(r-4.5-noble)doctest_0.3.0.tar.gz(r-4.4-noble)
doctest_0.3.0.tgz(r-4.4-emscripten)doctest_0.3.0.tgz(r-4.3-emscripten)
doctest.pdf |doctest.html✨
doctest/json (API)
NEWS
| # Install 'doctest' in R: |
| install.packages('doctest', repos = c('https://hughjonesd.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/hughjonesd/doctest/issues
Last updated 10 months agofrom:25194e2cb5 (on v0.3.0). Checks:OK: 7. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Nov 20 2024 |
| R-4.5-win | OK | Nov 20 2024 |
| R-4.5-linux | OK | Nov 20 2024 |
| R-4.4-win | OK | Nov 20 2024 |
| R-4.4-mac | OK | Nov 20 2024 |
| R-4.3-win | OK | Nov 20 2024 |
| R-4.3-mac | OK | Nov 20 2024 |
Exports:dt_roclettest_doctests
Dependencies:brewbriocallrclicommonmarkcpp11crayondescdiffobjdigestevaluatefsgluehighrjsonliteknitrlifecyclemagrittrpkgbuildpkgloadpraiseprocessxpspurrrR6rlangroxygen2rprojrootstringistringrtestthatvctrswaldowithrxfunxml2yaml
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Write testthat tests for your examples, using roxygen tags | doctest-package doctest |
| Start a doctest | @doctest doctest-tag |
| Add an example from a file | @doctestExample doctestExample-tag |
| Create the doctest roclet | dt_roclet |
| Create an expectation | @expect expect-tag |
| Create an expectation as-is | @expectRaw expectRaw-tag |
| Exclude example code from a test | @omit @resume omit-tag resume-tag |
| Create a snapshot test | @snap snap-tag |
| Test doctests in a package | test_doctests |
| Add a line of code to the test | @testRaw testRaw-tag |
