Review vignettes

[steffilazerte]

The vignettes were created a while ago and could use a review to make sure

• They still make sense
• The figures are present
• The formatting looks okay

Vignettes are found in the following folders:

• https://github.com/ropensci/weathercan/tree/main/vignettes
• https://github.com/ropensci/weathercan/tree/main/vignettes/articles

Vignettes can be reviewed online:

• https://docs.ropensci.org/weathercan/ (look at the Articles drop down menu to the left)

[tanmaydimriGSOC]

Hi @steffilazerte,

I’d like to work on reviewing the vignettes for this issue.

My plan is to go through the vignette source files (.Rmd), build them locally, and update any outdated examples, errors, or unclear explanations so they compile cleanly with the current package version. This will be documentation-only, with no changes to package behavior.

Please let me know if that sounds good or if there’s a specific vignette you’d prefer I start with.

Thanks!

[steffilazerte]

Hi @tanmaydimriGSOC, that sounds wonderful! I'm on Holidays now so won't generally be available until Jan 5th, but I'm excited for your review! I would just bear in mind that some vignettes are 'precompiled' (those ones that have an .orig extension appended). They may be a bit finicky to work with (see the precompile.R file in the vignettes folder).

When I'm back I'll be available to help or answer any questions you might have, thanks again!