search

MUCollective / multiverse

R package for creating explorable multiverse analysis
https://mucollective.github.io/multiverse/
GNU General Public License v3.0
62 stars 5 forks source link

Deal with VignetteBuilder NOTE #59

Closed mjskay closed 3 years ago

mjskay commented 4 years ago

From github action checks:

Package has a VignetteBuilder field but no prebuilt vignette index.

Presumably this is because you have --no-build-vignettes on, which is understandable since building them takes forever :).

One solution would be to use the approach in tidybayes, which (when the test environment is CRAN) "builds" them into HTML but doesn't execute any of the code chunks. @abhsarma let me know if you want me to set that up.

For reference, how long does it take to build the vignettes currently? I started a build but killed it after 5 minutes because I didn't feel like waiting.

mjskay commented 4 years ago

(since it is just a note we could also leave it as-is for now, as notes won't cause the github action check to fail, only warnings)

abhsarma commented 4 years ago

I think it takes around 20 mins or so but its mostly one of the vignettes (the DANCE example from the EMAR paper) I'll take a look at it and see if that one can be sped up somehow

abhsarma commented 3 years ago

Unless I am missing something, I don't seem to be getting this note anymore (on the commits to the dev branch). Should we close this?

mjskay commented 3 years ago

I still see the note on github actions? The runs don't fail on NOTEs so you have to go in and read the Check output every once in awhile

abhsarma commented 3 years ago

ah yes, couldn't find it. I am not sure how to deal with this and couldn't find anything helpful online either. Would you mind taking a look at it whenever you get a chance?

mjskay commented 3 years ago

K I can look at that. what's the timeline for this?

abhsarma commented 3 years ago

whenever you get the chance I guess. I think besides this, we can decide on whether we want the tangle interaction working before we do a beta release

mjskay commented 3 years ago

ah yeah. the tangle stuff would be cool, since that kind of differentiates it from other stuff

abhsarma commented 3 years ago

Right, but between the work that needs to be done on the vis, parallelisation stuff and tangle, I am a little stretched and not sure when I'll be able to get at that. I am just worried that of pushing back releasing it out there too much? Maybe it might be useful to talk about prioritising things?

abhsarma commented 3 years ago

okay this is because all the checks on github actions do not build vignettes, so it goes away if I just run devtools::check(remotes = TRUE, manual = TRUE) or devtools::check_win_devel()