Include example tests in testAnalysis#69
Open
FBartos wants to merge 1 commit intojasp-stats:masterfrom
Open
Conversation
Add includeExamples parameter (default TRUE) to testAnalysis and propagate it to getTestFilesMatchingName. Extend getTestFilesMatchingName to also scan test-example-*.R files for runAnalysis("Name") calls and include those matches, while preserving existing filename matches. Update error messaging and documentation (man/testAnalysis.Rd) and add details about the new option so callers can opt out by setting includeExamples = FALSE.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates testAnalysis() so it can optionally include auto-generated example-based tests when running a single analysis’ tests, aligning testAnalysis() behavior with tests produced by makeTestsFromExamples().
Changes:
- Add
includeExamplesparameter (defaultTRUE) totestAnalysis()and pass it through togetTestFilesMatchingName(). - Extend
getTestFilesMatchingName()to includetest-example-*.Rfiles that containrunAnalysis("AnalysisName", ...)calls. - Update roxygen/Rd documentation to describe the new behavior and opt-out mechanism.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
R/test.R |
Adds includeExamples parameter and implements example-test discovery by scanning test-example-*.R contents for runAnalysis("Name"). |
man/testAnalysis.Rd |
Documents the new includeExamples option and clarifies that example-generated tests can be included by default. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add includeExamples parameter (default TRUE) to testAnalysis and propagate it to getTestFilesMatchingName. Extend getTestFilesMatchingName to also scan test-example-*.R files for runAnalysis("Name") calls and include those matches, while preserving existing filename matches. Update error messaging and documentation (man/testAnalysis.Rd) and add details about the new option so callers can opt out by setting includeExamples = FALSE.