suppdata icon indicating copy to clipboard operation
suppdata copied to clipboard

Switch vignette to R Markdown and add more examples

Open nuest opened this issue 6 years ago • 4 comments

The vignette is currently an Rnw file, which is fine, but also prevents it to be rendered nicely, e.g. as part of a pkgdown-Website (if we ever want one).

The actual advantage I would see is that an R Markdown vignette is much more accessible to newcomers. With some more examples, it would allow us to add a Badger for mybinder.org, which could open the vignette in RStudio and very nicely demonstrate the package. Try out the following link to demonstrate this (must navigate to vignette manually, but cannot compile PDF because there is no LaTeX):

https://mybinder.org/v2/gh/ropensci/suppdata/master?urlpath=/rstudio

There are more than enough examples in the tests that we could pick to show off in the vignette. An Rmd vignette can be run easily (by chunk) or completely (by installing knitr etc.)

The badge would be

Binder

nuest avatar May 02 '19 08:05 nuest

Sure, I would be fine with moving it over to Markdown. I'm not flagging this as a personal high priority, but I would be happy to do it. The easier to use the better, for sure.

willpearse avatar May 02 '19 17:05 willpearse

Does the launch of this new ROpenSci documentation integration site (https://ropensci.org/technotes/2019/06/07/ropensci-docs/) change your opinion on this? I think our auto-generated one is pretty awesome (https://docs.ropensci.org/suppdata/). No badge though :-(

willpearse avatar Jun 06 '19 15:06 willpearse

Yeah, the new docs website is really cool. Agree with you that the switch to R Markdown is not a high priority.

nuest avatar Jul 27 '19 13:07 nuest

Great, thanks!

willpearse avatar Jul 29 '19 21:07 willpearse