pkgcheck results - ropensci

s3alfisc / fwildclusterboot

Fast Wild Cluster Bootstrap Inference for Regression Models / OLS in R. Additionally, R port to WildBootTests.jl via the JuliaConnectoR.

https://s3alfisc.github.io/fwildclusterboot/

GNU General Public License v3.0

22 stars 4 forks source link

pkgcheck results - ropensci #57

Closed github-actions[bot] closed 1 year ago

github-actions[bot] commented 1 year ago

Checks for fwildclusterboot (v0.11)

git hash: 00c38b8d

:heavy_check_mark: Package is already on CRAN.
:heavy_check_mark: has a 'codemeta.json' file.
:heavy_check_mark: has a 'contributing' file.
:heavy_multiplication_x: The following functions have no documented return values: [boot_ssc, pval, teststat]
:heavy_check_mark: uses 'roxygen2'.
:heavy_check_mark: 'DESCRIPTION' has a URL field.
:heavy_check_mark: 'DESCRIPTION' has a BugReports field.
:heavy_check_mark: Package has at least one HTML vignette
:heavy_check_mark: All functions have examples.
:heavy_multiplication_x: Function names are duplicated in other packages
:heavy_check_mark: Package has continuous integration checks.
:heavy_multiplication_x: Package coverage is 58.6% (should be at least 75%).
:heavy_check_mark: R CMD check found no errors.
:heavy_check_mark: R CMD check found no warnings.

Important: All failing checks above must be addressed prior to proceeding

Package License: GPL-3

s3alfisc commented 1 year ago

cmd check fails because pkgcheck does not find the JULIA_BINDIR environment flag - the workflow of course does not install Julia, WildBootTests.jl etc, and it fails because I failed to add the clause that exludes the test if Julia is not found. I have changed this in a recent commit
coverage is still low because I am excluding all Julia tests (except the one that fails)
the concerned duplicated function / method names are pval and teststat - I like these function names and think it is in fact a benefit that they are used in other packages
the only remaining library() calls are in vignettes, readme and news files. Should I get rid of all of these and replace with requireNamespace()?
when running pkgcheck locally, I only find one line with more than 80 characters - I have kept this line because otherwise, the argument checks via the dreamerr package would fail (dreamerr does not work nicely with linebreaks)

github-actions[bot] commented 1 year ago

Checks for fwildclusterboot (v0.11)

git hash: 2fba1998

:heavy_check_mark: Package is already on CRAN.
:heavy_check_mark: has a 'codemeta.json' file.
:heavy_check_mark: has a 'contributing' file.
:heavy_check_mark: uses 'roxygen2'.
:heavy_check_mark: 'DESCRIPTION' has a URL field.
:heavy_check_mark: 'DESCRIPTION' has a BugReports field.
:heavy_check_mark: Package has at least one HTML vignette
:heavy_check_mark: All functions have examples.
:heavy_multiplication_x: Function names are duplicated in other packages
:heavy_check_mark: Package has continuous integration checks.
:heavy_multiplication_x: Package coverage is 60.7% (should be at least 75%).
:heavy_check_mark: R CMD check found no errors.
:heavy_check_mark: R CMD check found no warnings.

Important: All failing checks above must be addressed prior to proceeding

Package License: GPL-3

assignUser commented 1 year ago

@s3alfisc You can change your pkgcheck action file to install additional system dependencies like Julia (e.g. via an additional step using https://github.com/julia-actions/setup-julia) We have an open issue to add documentation about that (with a small example on how to do it: https://github.com/ropensci-review-tools/pkgcheck-action/issues/23#issuecomment-1027035722

s3alfisc commented 1 year ago

Hi @assignUser, thanks for your feedback! I had in fact done this the other day but then reverted the commit as the unit tests run for a while, and I first wanted to make sure that pkgcheck() runs without me fiddling with the yaml file. I'll try to keep an eye on the issue and would be happy to eventually add a Julia example to the documentation.

github-actions[bot] commented 1 year ago