Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-13 Thread Timothée Carayol
-devel-boun...@r-project.org [r-devel-boun...@r-project.org] On Behalf Of Paul Johnson [pauljoh...@gmail.com] Sent: 10 September 2011 02:38 To: r-de...@stat.math.ethz.ch Subject: [Rd] Please explain your workflow from R code - package - R code     - package Hi, I'm asking another one of those

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-10 Thread Barry Rowlingson
On Fri, Sep 9, 2011 at 7:41 PM, Hadley Wickham had...@rice.edu wrote: It's not the cool kids who are doing this, it's the lazy kids ;) laziness being one of the three virtues of a programmer. The other two being hubris and something else I don't have time to look up at the moment.

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-10 Thread Joshua Ulrich
On Sat, Sep 10, 2011 at 11:23 AM, steven mosher mosherste...@gmail.com wrote: All I need now is a tool to go through the 4 packages I already created without Roxygen and  spit out source files with the Roxygen comments in them... really lazy. That's what Rd2roxygen does... Best, -- Joshua

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-10 Thread Yihui Xie
Exactly. Rd2roxygen is proud to be a member of the Lazy Ally, and tries to make diligent developers lazier... Although it does not guarantee a perfect transition from Rd to roxygen (be sure to check out the documentation), it should be able to save you a considerable amount of time. Regards,

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-10 Thread steven mosher
Thanks, I was too lazy to even look for it. On Sat, Sep 10, 2011 at 9:31 AM, Joshua Ulrich josh.m.ulr...@gmail.com wrote: On Sat, Sep 10, 2011 at 11:23 AM, steven mosher mosherste...@gmail.com wrote: All I need now is a tool to go through the 4 packages I already created without Roxygen

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-10 Thread Mark.Bravington
September 2011 02:38 To: r-de...@stat.math.ethz.ch Subject: [Rd] Please explain your workflow from R code - package - R code - package Hi, I'm asking another one of those questions that would be obvious if I could watch your work while you do it. I'm having trouble understanding the workflow

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

2011-09-09 Thread Paul Johnson
Hi, I'm asking another one of those questions that would be obvious if I could watch your work while you do it. I'm having trouble understanding the workflow of code and package maintenance. Stage 1. Make some R functions in a folder. This is in a Subversion repo R/trunk/myproject Stage 2.

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-09 Thread Spencer Graves
I write the *.Rd file including examples that I use as unit tests before I write the code. Others criticize this approach insisting that \examples is NOT a place for unit tests. There are unit testing protocols for R that I have not learned. Instead, I rely on \dontshow inside

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-09 Thread Dirk Eddelbuettel
On 9 September 2011 at 11:38, Paul Johnson wrote: | Hi, | | I'm asking another one of those questions that would be obvious if I | could watch your work while you do it. | | I'm having trouble understanding the workflow of code and package maintenance. | | Stage 1. Make some R functions in a

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-09 Thread Duncan Murdoch
On 09/09/2011 12:38 PM, Paul Johnson wrote: Hi, I'm asking another one of those questions that would be obvious if I could watch your work while you do it. I'm having trouble understanding the workflow of code and package maintenance. Stage 1. Make some R functions in a folder. This is in a

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-09 Thread Spencer Graves
On 9/9/2011 10:47 AM, Duncan Murdoch wrote: On 09/09/2011 12:38 PM, Paul Johnson wrote: Hi, I'm asking another one of those questions that would be obvious if I could watch your work while you do it. I'm having trouble understanding the workflow of code and package maintenance. Stage 1.

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-09 Thread Hadley Wickham
If you write the *.Rd file before (like Spencer) or soon after writing the code, then design errors will usually stick out at you, and you can modify the functions.  If you keep your functions small, you'll get them working early, and won't have a lot of problems keeping them in sync with the

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-09 Thread Hadley Wickham
| 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

Re: [Rd] Please explain your workflow from R code - package - R code - package

2011-09-09 Thread baptiste auguie
+1 for roxygen2, lazycoolness oblige. An alternative that has not been mentioned is inlinedocs, http://inlinedocs.r-forge.r-project.org/ I don't use it myself, but it might appeal to your workflow. baptiste On 10 September 2011 06:41, Hadley Wickham had...@rice.edu wrote: | In other