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

From: Spencer Graves <spencer.graves_at_prodsyse.com>
Date: Fri, 09 Sep 2011 10:05:27 -0700

       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 \examples.

       There are two documents on CRAN -> "Documentation: Contributed" entitled "Creating R Packages". They might help.

       Hope this helps.
       Spencer


On 9/9/2011 9:49 AM, Joshua Ulrich wrote:
> On Fri, Sep 9, 2011 at 11:38 AM, Paul Johnson<pauljohn32@gmail.com> 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 Subversion repo
>>
>> R/trunk/myproject
>>
>> Stage 2. Make a package:
>>
>> After the package.skeleton, and R check, I have a new folder with the
>> project in it,
>>
>> R/trunk/myproject/mypackage
>> DESCRIPTION
>> man
>> R
>>
>> I to into the man folder and manually edit the Rd files. I don't
>> change anything in the R folder because I think it is OK so far.
>>
>> And eventually I end up with a tarball mypackage_1.0.tar.gz.
>>
>> Stage 3. How to make the round trip? I add more R code, and
>> re-generate a package.
>>

>> package.skeleton obliterates the help files I've already edited.
>>
> See ?dump and ?prompt.
>
>> So keeping the R code in sync with the documentation appears to be a hassle.

>>
>> 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?

>>
> Yes. See the roxygen / roxygen2 and devtools packages.
>
>> pj
>>
>> --
>> Paul E. Johnson
>> Professor, Political Science
>> 1541 Lilac Lane, Room 504
>> University of Kansas
>>
>> ______________________________________________
>> R-devel_at_r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
>>
> Best,
> --
> Joshua Ulrich | FOSS Trading: www.fosstrading.com
>
> ______________________________________________
> R-devel_at_r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>



R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Fri 09 Sep 2011 - 17:10:00 GMT

This quarter's messages: by month, or sorted: [ by date ] [ by thread ] [ by subject ] [ by author ]

All messages

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.2.0, at Fri 09 Sep 2011 - 18:00:28 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-devel. Please read the posting guide before posting to the list.

list of date sections of archive