search

OHDSI / PatientLevelPrediction

An R package for performing patient level prediction in an observational database in the OMOP Common Data Model.
https://ohdsi.github.io/PatientLevelPrediction
181 stars 88 forks source link

What should we do with our vignettes? #448

Open egillax opened 2 months ago

egillax commented 2 months ago

Currently our vignettes are automatically built into html both for website and package. Additionally there are manually built pdf vignettes (built with this). This manual step is not ideal. It causes the pdf vignettes to easily be out of date and old vignettes are not removed. Recently I removed a bunch of old ones.

Further for example roxygen does not recommend anymore that built vignettes are stored in a package.

I think there are two ways forward that would simplify matters:

  1. Switch completely over to html, people can the access our vignettes either on the website or with browseVignettes("PatientLevelPrediction") on their local computers.

  2. Automatically build the pdf vignettes. This can be accomplished by switching the vignette engine to rmarkdown v2 (knitr::rmarkdown) instead of v1 (knitr::knitr).

I would be in favor of 1. Personally I never open the pdf's. Looking at which packages store pdf's in my R-lib folder, it's about ~80 out of ~440 packages.

But this needs discussion. @jreps @lhjohn @rossdwilliams @ChungsooKim

ChungsooKim commented 1 month ago

Hi @egillax, sorry for the late response. I also prefer option 1.