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

srr standards not parsed correctly #111

Closed helske closed 1 year ago

helske commented 1 year ago

The srr_report() for the package fails with somewhat cryptic error message This is not an 'srr' package. because in srr_stats_standards.R the necessary NULL values are commented out, e.g.

#' @srrstats {RE7.0} *Tests with noiseless, exact relationships between
#' predictor (independent) data.*
#' 
#' @noRd
# NULL

Tagging @meghapsimatrix who noticed this issue first. Also tagging @mpadge, I suggest that the error message could be bit more informative (e.g. "could not find any srr tags in package's Rd files" or something similar.

s3alfisc commented 1 year ago

Hi @helske, is this something that I can fix? Should I just un-comment the NULL value?

mpadge commented 1 year ago

@s3alfisc yep, indeed. Just replace # NULL with NULL

s3alfisc commented 1 year ago

Should be fixed =)

s3alfisc commented 1 year ago

Here is what I receive now when running srr_report():

> library(srr)
> srr_report()
ℹ Loading fwildclusterboot
────────────── rOpenSci Statistical Software Standards ─────────────

── @srrstats standards (70 / 116): 
  * [G1.0, G1.1, G1.2, G1.3, G1.4, G1.4a, G1.6, G2.0, G2.0a, G2.1, G2.1a, G2.2, G2.3, G2.3a, G2.3b, G2.4, G2.4a, G2.4c, G2.4d, G2.6, G2.7, G2.8, G2.10, G2.11, G2.12, G2.13, G2.14, G2.14a, G2.14b, G2.14c, G2.15, G3.0, G3.1, G3.1a, G4.0, G5.0, G5.1, G5.2, G5.2a, G5.2b, G5.4, G5.4b, G5.5, G5.6, G5.6a, G5.6b, G5.7, G5.8, G5.8c, G5.9b, RE1.0, RE1.1, RE1.4, RE2.0, RE3.0, RE3.1, RE3.2, RE3.3, RE4.0, RE4.3, RE4.4, RE4.5, RE4.17, RE4.18, RE5.0, RE6.0, RE6.1, RE6.2, RE6.3, RE7.0] on line#332 of file [R/srr-stats-standards.R]

── @srrstatsNA standards (46 / 116): 
  * [G1.5, G2.4b, G2.4e, G2.5, G2.9, G5.3, G5.10, G5.11, G5.11a, G5.12, G5.4a, G5.4c, G5.8a, G5.8b, G5.8d, G5.9, G5.9a, RE1.2, RE1.3, RE1.3a, RE2.1, RE2.2, RE2.3, RE2.4, RE2.4a, RE2.4b, G2.16, RE4.1, RE4.2, RE4.6, RE4.7, RE4.8, RE4.9, RE4.10, RE4.11, RE4.12, RE4.13, RE4.14, RE4.15, RE4.16, RE7.0a, RE7.1, RE7.1a, RE7.2, RE7.3, RE7.4] on line#542 of file [R/srr-stats-standards.R]
────────────────────────────────────────────────────────────────────
Loading required namespace: rmarkdown
Error in data.frame(category = cats$category, std_prefix = cats$prefix,  : 
  arguments imply differing number of rows: 9, 8

@mpadge, do you have an idea what might be going wrong?

helske commented 1 year ago

I think you need to update the srr package from github or r-universe.

s3alfisc commented 1 year ago

Yes, updating the srr package does the job. =)