From hadley at rice.edu  Fri Sep  9 20:41:39 2011
From: hadley at rice.edu (Hadley Wickham)
Date: Fri, 9 Sep 2011 13:41:39 -0500
Subject: [Rd] Please explain your workflow from R code -> package -> R
 code -> package
In-Reply-To: <20074.20512.95925.44559@max.nulle.part>
References: <CAErODj_mu8dOujVCJh14d-UbDw9qrq-9CC3MeeCSQ6d28-rJDg@mail.gmail.com>
	<20074.20512.95925.44559@max.nulle.part>
Message-ID: <CABdHhvE2amMC=DVr1tykkrnLZ3c5omSJPcHhoC9EuH4tpvXBWQ@mail.gmail.com>

> | In other languages, I've seen to write the documentation inside the
> | code files and then post-process to make the documentation. ?Is there
> | a similar thing for R, to unify the R code development and
> | documentation/package-making process?
>
> You can also follow the cool kids who these days tie some of this together
> using roxygen.

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

-- 
Assistant Professor / Dobelman Family Junior Chair
Department of Statistics / Rice University
http://had.co.nz/



[Rd] Please explain your workflow from R code -> package -> R code -> package
Hadley Wickham