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

Prepare for CRAN release #149

Open
3 tasks done
Bisaloo opened this issue May 1, 2024 · 2 comments · Fixed by #167
Open
3 tasks done

Prepare for CRAN release #149

Bisaloo opened this issue May 1, 2024 · 2 comments · Fixed by #167

Comments

@Bisaloo
Copy link
Member

Bisaloo commented May 1, 2024

I have not reviewed the package code or design but upon a cursory look, here are the points that almost surely will cause issues with CRAN:

  • the package is too large (>= 5MB):
    • some data is duplicated across data and inst/extdata, can this be fixed?
    • can a subset of the dengue2020 dataset be used in examples? Examples are just here to demonstrate the function usage, it's not so important if the result is not necessarily meaningful from a scientific point of view. Vignettes are here to fill this gap.
    • the getting_started.Rmd and sivirep.Rmd vignettes seem mostly duplicated (both leading to an almost 50MB HTML file)
    • I would convert the gif to webm, which is widely supported by all web browsers now (source): I achieved a 20x file size reduction doing this (with ffmpeg). Please let me know if you'd like me to submit a PR with this change
  • examples take too long
    • this should be improved automatically if you follow the smaller example dataset recommendation above
    • longer examples should be wrapped in \donttest{}
  • the package is in Spanish. This is not a problem in itself but it's uncommon enough that CRAN is likely to raise an eyebrow over this. I would pre-empt any comments by explaining in cran-comments.md to scope of the package, why it has to be in Spanish, and how you have tried to follow recommendation from the official 'Writing R Extensions' guide: https://cran.r-project.org/doc/manuals/R-exts.html#The-DESCRIPTION-file-1
@GeraldineGomez
Copy link
Member

GeraldineGomez commented May 3, 2024

Hi @Bisaloo, thanks for your review 😊:

  • the package is too large (>= 5MB):
  • examples take too long:
    • I've wrapped some longer examples in \dontrun{}. I'll evaluate which functions to implement \donttest{} and replace \dontrun{}.
  • Thank you for bringing up this point. We'll provided a detailed explanation of the package's scope and why Spanish is necessary for its users and NIH needs.

@GeraldineGomez
Copy link
Member

GeraldineGomez commented May 10, 2024

Hi @Bisaloo,

The issue related to the size of the dengue2020 dataset was resolved in PR #167; now its weight is 4.3 KB

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

Successfully merging a pull request may close this issue.

2 participants