Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

One-click documentation for testthat unit tests

License

NotificationsYou must be signed in to change notification settings

urniaz/testthatdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Thetestthatdocs package provides utilities for generating structured, idempotent listings oftest_that() blocks in R test files.
It automatically creates both global and section-specific listings using roxygen-style comment markers.

These listings make it easier to navigate, audit, and document your tests, and they integrate naturally with pkgdown and roxygen2 documentation workflows.

install.packages("testthatdocs")

Key Features

  • Scans.R test files for lines beginning withtest_that("title").
  • Extracts test titles (as raw text or expressions).
  • Automatically generates roxygen-style listings:
    • #' @testsList – global list of all tests.
    • #' @testsSection – section-specific lists.
    • #' @testsItem – numbered entries for each test.
  • Two numbering templates:
    • "simple" →{g}
    • "advanced" →{g}.{s}.{i}.{l}
  • Fullyidempotent — listings are replaced, not duplicated.
  • Handles both single files and full testthat directories.

About

One-click documentation for testthat unit tests

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

[8]ページ先頭
©2009-2025 Movatter.jp