You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
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.
The text was updated successfully, but these errors were encountered: