Repository navigation
Add maglab/magmap tests, coverage CI workflow and AGENTS.md - #21
Merged
Merged
Conversation
Co-authored-by: asgr <5617132+asgr@users.noreply.github.com>
Co-authored-by: asgr <5617132+asgr@users.noreply.github.com>
Co-authored-by: asgr <5617132+asgr@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The requested pre-merge R tests and coverage workflow have not been executed, leaving runtime behavior and CI dependency installation unverified.
No open issues 🎉
What changed in this PR
Adds direct tests for maglab and magmap, coverage reporting in CI, and contributor guidance for the magicaxis R package.
Changes:
- Tests label structure, trimming, logarithmic placement, invalid options, mapping bounds, and flipped mappings.
- Adds an Ubuntu coverage workflow that prints coverage and generates a Cobertura report without uploading results or enforcing a threshold.
- Documents package layout, dependencies, development commands, and testing conventions.
The new tests and workflow remain unverified at runtime.
| File | Description |
|---|---|
tests/testthat/test-maglab-magmap.R |
Adds computational tests for label generation and numeric mapping. |
AGENTS.md |
Documents contributor and agent guidance. |
.github/workflows/test-coverage.yaml |
Adds coverage reporting for pushes and pull requests targeting main or master. |
Review effort: Balanced
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.
Improves test coverage, adds a coverage CI job and documents the package for contributors and agents. R was not available in the authoring environment, so none of this has been run. Please run the tests and the new workflow before merging.
tests/testthat/test-maglab-magmap.R)maglabormagmapdirectly, so I added those.maglabtests cover the return structure,trim, log label placement, and the error whenusemultlocis used withoutlog=TRUE.magmaptests cover the output range and thatflip=TRUEinverts the mapping.magband,magproj,magMWdustandmagimageRGBstill appear to lack direct tests. I chose targets by reading the test files, not from a coverage report..github/workflows/test-coverage.yaml)covrjob on Ubuntu, run on push and PR tomain/master. It prints coverage and writes a Cobertura report. It does not upload results or enforce a threshold.R-CMD-check.yamlis unchanged.exportPatternexports and the hand-writtenman/Rd files.ParmOffdependency, test and check commands, the null-device convention for plotting tests, CI, and style.