Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trac matrix fixes #31

Closed
wants to merge 7 commits into from
Closed

Trac matrix fixes #31

wants to merge 7 commits into from

Conversation

barrettk
Copy link
Collaborator

@barrettk barrettk commented Aug 24, 2023

This PR includes amendments to the traceability matrix related to #19. It also captures other discovered issues.

  • basename error: usually arose due to exports not being properly discovered due to exportPattern methods, or mutli-lined function declarations being used
  • .init error: some cases were addressed in trace-matrix-reorg, but some were related to no R/ directory existing. Support for no R/ directory was added.
  • invalid regular expression. This was taken care of in trace-matrix-reorg when the switch to using parse over regex for mapping the test files was made. However, some improvements were made to the traceability matrix based on the results of these two packages

closes #19

 - needs test
 - changed filter_symbol_functions to filter based on symbol patterns instead of specific functions
 - support for setGeneric and other types should not be needed.
 - TODO: add test scenario
 - still may refactor this function to make use of `parse`, and attempt to move away from regex, but this is a good baseline for capturing these types of functions
 - mutli-lined function declarations
 - no R directory
   - After writing the test for the traceability matrix, I realized we needed one for testing the expected results of this scenario as well. Could have been done in a separate PR, but it seemed relevant enough since I had to add this new scenario to the setup file anyways
   - We should confirm if we want covr to fail if there is no R/ directory. That refactor should be a separate PR if done. There are several cases where R packages do not have R/ directories, and im not sure it makes sense to penalize the score for those cases.
 - traceability matrix cannot be created without exports: error out
This was referenced Aug 24, 2023
Base automatically changed from trace-matrix-reorg to main August 24, 2023 17:38
@barrettk barrettk marked this pull request as ready for review August 24, 2023 17:38
@kyleam
Copy link
Collaborator

kyleam commented Sep 14, 2023

This was superseded by gh-42, with many of these changes incorporated there.

@kyleam kyleam closed this Sep 14, 2023
@kyleam kyleam deleted the trac-matrix-fixes branch September 14, 2023 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add_traceability errors
2 participants