add vignette
Closed this issue · 7 comments
Hi there - does this issue still need someone's help? I've been interested in developing R vignettes for some time, and can help out if wanted.
hi 👋 yes!
have you made a vignette in an R package before? let me know either way then we can proceed from there.
Cool. I like to have vignettes pre-built for packages that make web requests, so i just use knitr (and not rmarkdown). I've set up the structure for the vignette in the last commit, so do update before making changes. Edit the file https://github.com/ropensci/natserv/blob/master/inst/vign/natserv_vignette.Rmd and then in your command line just type make and it should run the vignette in inst/vign and move the updated version to vignettes dir
Will do, thanks for the clear guide. If any issues come up I'll let you know, but this seems quite straightforward.
Hey @sckott - all done! I'm just about to make a pull request to the ropensci repo containing the knit vignette.