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

Generate srr reports organized by standard, rather than by file #44

Open
noamross opened this issue Oct 3, 2024 · 0 comments
Open

Generate srr reports organized by standard, rather than by file #44

noamross opened this issue Oct 3, 2024 · 0 comments

Comments

@noamross
Copy link

noamross commented Oct 3, 2024

srr compliance reports (e.g. https://ropensci-review-tools.github.io/roreviewapi/static/GLMMcosinor_srrc4251092.html) are organized by the file and line number where code annotations are, which is useful as you are going line-by-line in the code, matching the standard codes against what they mean. However, I think in terms of understanding the overall compliance of the package, it would make more sense to organize them by standard, like so:

## General Standards

...

- G1.4a All internal (non-exported) functions should also be documented in standard [roxygen2](https://roxygen2.r-lib.org/) format, along with a final @noRd tag to suppress automatic generation of .Rd files.*
    - R/amp_acro.R [line #61](https://github.com/RWParsons/GLMMcosinor/blob/main/R/amp_acro.R#L61), [line #108](https://github.com/RWParsons/GLMMcosinor/blob/main/R/amp_acro.R#L61)
...

I, and I think many reviewers, tend to go through a package a few times with a focus on different topics. So, for instance, it's helpful to have a section with everything from testing standards.

I realize this could go either way, so I suggest implementing this as an option, and/or printing both versions as different sections in the standard reports.

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

No branches or pull requests

1 participant