TestAudit -- test audit functionality

Description

The TestAudit package provides a small report about the tests of a package. The report lists the number and location of tests, classifies how tests are organized, and gives simple textual checks for exported functions, options, silenced tests, and FIXME or TODO comments.

Authors

Version

This documentation describes version 0.1 of TestAudit, released May 19, 2026.

Citation

If you have used this package in your research, please cite it as follows:

@misc{TestAuditSource,
  title = {{TestAudit: test audit functionality. Version~0.1}},
  author = {Taylor Brysiewicz and Ashley Dean and Connor Haynes and David K. Johnson and Guanyu Li and Keller VandeBogert},
  howpublished = {A \emph{Macaulay2} package available at
    \url{https://github.com/Macaulay2/M2/tree/stable/M2/Macaulay2/packages}}
}

Exports

Functions and commands
- testAudit -- produce a test audit report for a package
- testScore -- compute the heuristic test score for a package
Methods
- testAudit(Package) -- see testAudit -- produce a test audit report for a package
- testAudit(String) -- see testAudit -- produce a test audit report for a package
- testScore(Package) -- see testScore -- compute the heuristic test score for a package
- testScore(String) -- see testScore -- compute the heuristic test score for a package
Symbols
- Experimental (missing documentation)
- CommentReport -- see testAudit -- produce a test audit report for a package
- ScoreReport -- see testAudit -- produce a test audit report for a package
- SpeedReport -- see testAudit -- produce a test audit report for a package

For the programmer

The object TestAudit is a package, defined in TestAudit.m2.

The source of this document is in TestAudit.m2:553:0.