Skip to content
Prev 41200 / 63421 Next

Please explain your workflow from R code -> package -> R code -> package

It's not the cool kids who are doing this, it's the lazy kids ;)
Roxygen(2) does remove a considerable amount of replication between
code and documentation (e.g. replicating function usage in two
places), and the close proximity between code and documentation does
make it easier to remember to update your documentation when the code
changes.

Roxygen2 adds a few other tools for reducing duplication like
templates, the ability to inherit parameter documentation from other
function, and the family tag to automatically add seealso references
between all members of a related family of functions.  These are
things that are painful to do by hand and add a significance
maintenance burden.

I agree that there's no silver bullet, but good tools certainly can
make life easier.

Hadley

Thread (16 messages)

Paul Johnson Please explain your workflow from R code -> package -> R code -> package Sep 9 Joshua Ulrich Please explain your workflow from R code -> package -> R code -> package Sep 9 Spencer Graves Please explain your workflow from R code -> package -> R code -> package Sep 9 Dirk Eddelbuettel Please explain your workflow from R code -> package -> R code -> package Sep 9 Duncan Murdoch Please explain your workflow from R code -> package -> R code -> package Sep 9 Spencer Graves Please explain your workflow from R code -> package -> R code -> package Sep 9 Hadley Wickham Please explain your workflow from R code -> package -> R code -> package Sep 9 Hadley Wickham Please explain your workflow from R code -> package -> R code -> package Sep 9 Baptiste Auguie Please explain your workflow from R code -> package -> R code -> package Sep 9 Barry Rowlingson Please explain your workflow from R code -> package -> R code -> package Sep 10 steven mosher Please explain your workflow from R code -> package -> R code -> package Sep 10 Joshua Ulrich Please explain your workflow from R code -> package -> R code -> package Sep 10 Yihui Xie Please explain your workflow from R code -> package -> R code -> package Sep 10 steven mosher Please explain your workflow from R code -> package -> R code -> package Sep 10 Mark Bravington Please explain your workflow from R code -> package -> R code -> package Sep 10 Timothée Carayol Please explain your workflow from R code -> package -> R code -> package Sep 13