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

Making updates of the cache as an exported function #291

Open
Melkiades opened this issue Aug 31, 2023 · 0 comments
Open

Making updates of the cache as an exported function #291

Melkiades opened this issue Aug 31, 2023 · 0 comments
Labels
enhancement New feature or request sme

Comments

@Melkiades
Copy link
Contributor

Melkiades commented Aug 31, 2023

There are few cravats for this being a vignette:

  • (unless specified by a dedicated flag) building vignettes is part of R CMD BUILD and build step is part of installing from sources, e.g. installing from GH. I am a little afraid of installation performance here.
  • Vignettes are exposed to the users. Do we really expect that users will read it?
    Having said that, I don't think that vignette is a good idea. Please correct me if I am missing something.
    To me, data files are integral part of the package. Script Functionality that creates them should be considered as an utility.
    Alternative way would be to introduce something like refresh() / snapshot() / create_new_datasets() function in the package namespace but do we really expect package users to trigger this procedure? I feel it's more on package maintainers. Moreover, this could make it a little bit more difficult to keep test coverage high - you would have to do the mocking or other clever tricks to be able to test that.

Originally posted by @pawelru in #290 (comment)

I would keep the vignette with eval = FALSE so to keep some connection with the past (and keep some guidance for updating the cache, which is good for a vignette). For tests and examples, we will see. I think anyway, if there are no updates on the diff with origin/main it should not do anything, so tests should go fine, but we need to be sure for branches etc..

@Melkiades Melkiades added enhancement New feature or request sme labels Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request sme
Projects
None yet
Development

No branches or pull requests

1 participant