mini-pw / PvSTATEM

R package for automated analysis of serological data
https://mini-pw.github.io/PvSTATEM/
Other
2 stars 2 forks source link

bioconductor compatibility #47

Closed Fersoil closed 1 month ago

Fersoil commented 1 month ago

checks performed by:

BiocCheck::BiocCheck('new-package'=TRUE)
BiocCheck::BiocCheckGitClone()

gives some warnings and errors still, to be decided whether we want to fix them:

  1. WARNING: package version should be 0.99.0 for new packages in Bioconductor
  2. ERROR: Unable to find your email in the Support Site: HTTP 404 Not Found.
  3. WARNING: Empty or missing \value sections found in man pages.
  4. ERROR: System files found that should not be Git tracked. PvSTATEM.Rproj

3rd warning is difficult to fix, since the \value fields in R6 objects causes undesirable formatting. This field should be used as a @return statement, but when the method from the R6 class contains this field, its value is shown at the beginning of the documentation of the class.

image

Fersoil commented 1 month ago

Another requirements that cannot be checked via cmd is the size of output package - for now it sums up to 863 KB after compressing with devtools:build()

The build time takes less than 10 minues.

Fersoil commented 1 month ago

List of changes made:

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 63.41463% with 15 lines in your changes missing coverage. Please review.

Project coverage is 58.36%. Comparing base (2e5436c) to head (c2af9d0).

Files Patch % Lines
R/classes.R 70.83% 7 Missing :warning:
R/read_data.R 55.55% 4 Missing :warning:
R/standard_curves.R 50.00% 4 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #47 +/- ## ========================================== + Coverage 58.26% 58.36% +0.09% ========================================== Files 3 3 Lines 901 915 +14 ========================================== + Hits 525 534 +9 - Misses 376 381 +5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.