search

ropensci / weathercan

R package for downloading weather data from Environment and Climate Change Canada
https://docs.ropensci.org/weathercan
GNU General Public License v3.0
102 stars 29 forks source link

Need a vignette #15

Closed boshek closed 7 years ago

boshek commented 7 years ago

In advance of a CRAN submission I think it is prudent to have a good vignette built. The README is basically there but I think we could highlight a few more of the intricacies. Particularly I think we could flesh out the time interval argument explanation. That wasn't immediately obvious to me.

steffilazerte commented 7 years ago

By the way, I've started working on updating the README vignette. I'm looking into using pkgdown to turn the README/vignettes into a simple website to host on github.

boshek commented 7 years ago

Oh yeah - the pkgdown is so good. I think there might be a distinction between the README and vignette too. Have a look at the dplyr CRAN page: https://cran.r-project.org/web/packages/dplyr/index.html They have general usage covered by the README then more specific applications covered by vignettes. I wonder if the multiple station searches (using purrr) and then interpolate and add data stuff might be best as sub vignettes?

steffilazerte commented 7 years ago

That makes sense, the README can cover immediate usage (find station, get data), the vignettes more advanced/specific applications