ropensci / NLMR

📦 R package to simulate neutral landscape models 🏔
https://ropensci.github.io/NLMR/
65 stars 17 forks source link

Add missing dep for vignette #85

Closed maelle closed 2 years ago

maelle commented 2 years ago

Cf https://github.com/r-universe/ropensci/runs/4485274916?check_suite_focus=true via https://ropensci.r-universe.dev/ui#builds

maelle commented 2 years ago

You might also want to add https://github.com/ropensci/NLMR/blob/f285a9ec17cf3346b9251f80feabec2cb1a1abb2/_pkgdown.yml#L49 to DESCRIPTION under Suggests actually :thinking:

maelle commented 2 years ago

Now, if the deps are just for the website, you can use "Config/needs/website" instead of Suggests.

marcosci commented 2 years ago

Hi Maelle,

thanks for spotting this - but what exactly is Config/needs/website? 👯 I found it in pak, but ... can I somehow put this in the description?

Cheers

maelle commented 2 years ago

Sooo Config/needs/website is only for packages needed for the website but not R CMD check (e.g. packages used in a non-vignette article, packages needed for better autolinking by downlit e.g. if you mention an usethis function somewhere).

Now it's not supported just yet by the docs building system cf https://github.com/r-universe-org/build-docs/pull/1 so my suggestion was a bit too early.

maelle commented 2 years ago

@marcosci I see this updated chapter https://r-pkgs.org/description.html of the R packages book has info on the Config/needs fields!

jeroen commented 2 years ago

Let's give this a try to get the new docs online -- we can tweak it more later.