![]() ![]() Making a Shiny app doesn’t necessarily always make sense for every package, but there are certainly many times when it can be a great addition to a package’s “documentation”. The shinyjs demo app and colourpicker demo app are good examples of that. In fact, I’m such a strong believer in this idea, that almost every package I have released has a corresponding demo shiny app. You be the judge: after that one-sentence description of some functionality, would you rather go straight to the README, or see it in action first in a Shiny app online? I might be wrong, but I think it’s useful to interactively see what the package can do. ![]() What this means for package developers is that you can have an interactive webpage that lets users experiment with your package and see what it can do before having to read through the potentially lengthy function documentations/vignette.Īs an example, I recently released a package for adding marginal plots to ggplot2. In a nutshell, Shiny is a package that lets you run your R code as an interactive webpage. And with the use of Shiny, we now have another great tool we can use to showcase a package’s capabilities. Proper documentation is essential so that others will know what your package can do and how to do it. The former is a no-brainer, while the latter is what developers usually dread the most - the D-word (Documentation. Writing packages has become such an easy experience now that Hadley’s devtools is so powerful, and as a result there are new packages being released by useRs every single day.Ī good package needs to have two things: useful functionality, and clear usage instructions. The R community is generally very fond of open-source-ness and the idea of releasing all code to the public.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |