search

darwin-eu-dev / PaRe

PaRe (Package Reviewer) is the successor of the DependencyReviewer package.
https://darwin-eu-dev.github.io/PaRe/
3 stars 3 forks source link

Add PaRe reports to each package website #27

Closed ablack3 closed 1 year ago

ablack3 commented 1 year ago

Has anyone figured out how to add the PaRe report for each package to the package website as a vignette?

edward-burn commented 1 year ago

+1 this would be great, but maybe as an article instead of vignette (so PaRe doesn't need to be a dependency?) It would be nice if it looked like the usethis::use_tidy_contributing() function (in that you just run the function and the rest is taken care of)

mvankessel-EMC commented 1 year ago

I've added the report.rmd as a vignette (example). Which works fine. The only dynamic information at this point is the package name, and the package title. I'm planning on creating a function that takes those two from the user, and inject them into an rmd, which is then written as Report.rmd under ../vignettes/.

mvankessel-EMC commented 1 year ago

I added the addPareReport function that adds an rmd-file under ./vignettes/articles/PareReport.Rmd. d463c5cff1dccc2a99a0ec0b31bbbdcaaa43442a

Usage:

repo <- PaRe::Repository$new("path/to/package/repo")

PaRe::addPareArticle(repo)

The article should then be included when you re-build the package website, or you can build just the article using pkgdown::build_article()