R-helpers: Are there any ways to auto-generate R-friendly (e.g. will pass a compilation check) .Rd files given a set of .R code? How about GUIs that help properly format the .Rd files? Thanks! I want a basic set of .Rd files that I can update as I go, but as with most things my documentation typically lags behind my coding by a few days. --j -- Jonathan A. Greenberg, PhD Assistant Project Scientist Center for Spatial Technologies and Remote Sensing (CSTARS) Department of Land, Air and Water Resources University of California, Davis One Shields Avenue Davis, CA 95616 Phone: 415-763-5476 AIM: jgrn307, MSN: jgrn307 at hotmail.com, Gchat: jgrn307
I like the roxygen2 package for combining code and documentation. If you use Emacs + ESS, it will even create much of the roxygen code for you (and auto-revise it if you change the function arguments). Kevin Wright On Tue, Aug 23, 2011 at 6:55 PM, Jonathan Greenberg <greenberg@ucdavis.edu>wrote:> R-helpers: > > Are there any ways to auto-generate R-friendly (e.g. will pass a > compilation check) .Rd files given a set of .R code? How about GUIs > that help properly format the .Rd files? Thanks! I want a basic set > of .Rd files that I can update as I go, but as with most things my > documentation typically lags behind my coding by a few days. > > --j > > -- > Jonathan A. Greenberg, PhD > Assistant Project Scientist > Center for Spatial Technologies and Remote Sensing (CSTARS) > Department of Land, Air and Water Resources > University of California, Davis > One Shields Avenue > Davis, CA 95616 > Phone: 415-763-5476 > AIM: jgrn307, MSN: jgrn307@hotmail.com, Gchat: jgrn307 > > ______________________________________________ > R-help@r-project.org mailing list > https://stat.ethz.ch/mailman/listinfo/r-help > PLEASE do read the posting guide > http://www.R-project.org/posting-guide.html > and provide commented, minimal, self-contained, reproducible code. >[[alternative HTML version deleted]]
On 24/08/11 01:55, Jonathan Greenberg wrote:> R-helpers: > > Are there any ways to auto-generate R-friendly (e.g. will pass a > compilation check) .Rd files given a set of .R code? How about GUIs > that help properly format the .Rd files? Thanks! I want a basic set > of .Rd files that I can update as I go, but as with most things my > documentation typically lags behind my coding by a few days. > > --jSee inlinedocs package on CRAN. There are several examples included. Best, Philippe Grosjean
Thanks Kevin! Got started with roxygen tonight! Cheers! On Tue, Aug 23, 2011 at 6:28 PM, Kevin Wright <kw.stat at gmail.com> wrote:> I like the roxygen2 package for combining code and documentation.? If you > use Emacs + ESS, it will even create much of the roxygen code for you (and > auto-revise it if you change the function arguments). > > Kevin Wright > > On Tue, Aug 23, 2011 at 6:55 PM, Jonathan Greenberg <greenberg at ucdavis.edu> > wrote: >> >> R-helpers: >> >> Are there any ways to auto-generate R-friendly (e.g. will pass a >> compilation check) .Rd files given a set of .R code? ?How about GUIs >> that help properly format the .Rd files? ?Thanks! ?I want a basic set >> of .Rd files that I can update as I go, but as with most things my >> documentation typically lags behind my coding by a few days. >> >> --j >> >> -- >> Jonathan A. Greenberg, PhD >> Assistant Project Scientist >> Center for Spatial Technologies and Remote Sensing (CSTARS) >> Department of Land, Air and Water Resources >> University of California, Davis >> One Shields Avenue >> Davis, CA 95616 >> Phone: 415-763-5476 >> AIM: jgrn307, MSN: jgrn307 at hotmail.com, Gchat: jgrn307 >> >> ______________________________________________ >> R-help at r-project.org mailing list >> https://stat.ethz.ch/mailman/listinfo/r-help >> PLEASE do read the posting guide >> http://www.R-project.org/posting-guide.html >> and provide commented, minimal, self-contained, reproducible code. > >-- Jonathan A. Greenberg, PhD Assistant Project Scientist Center for Spatial Technologies and Remote Sensing (CSTARS) Department of Land, Air and Water Resources University of California, Davis One Shields Avenue Davis, CA 95616 Phone: 415-763-5476 AIM: jgrn307, MSN: jgrn307 at hotmail.com, Gchat: jgrn307
To avoid a possible confusion, please note it is roxygen2 rather than roxygen; both are packages on CRAN, but roxygen2 is an improved version and under maintenance; I guess the development of the original roxygen package has stopped. Emacs+ESS helps a whole lot in writing documentation! I really love C-c C-o Regards, Yihui -- Yihui Xie <xieyihui at gmail.com> Phone: 515-294-2465 Web: http://yihui.name Department of Statistics, Iowa State University 2215 Snedecor Hall, Ames, IA On Wed, Aug 24, 2011 at 3:31 AM, Jonathan Greenberg <greenberg at ucdavis.edu> wrote:> Thanks Kevin! ?Got started with roxygen tonight! ?Cheers! > > On Tue, Aug 23, 2011 at 6:28 PM, Kevin Wright <kw.stat at gmail.com> wrote: >> I like the roxygen2 package for combining code and documentation.? If you >> use Emacs + ESS, it will even create much of the roxygen code for you (and >> auto-revise it if you change the function arguments). >> >> Kevin Wright >> >> On Tue, Aug 23, 2011 at 6:55 PM, Jonathan Greenberg <greenberg at ucdavis.edu> >> wrote: >>> >>> R-helpers: >>> >>> Are there any ways to auto-generate R-friendly (e.g. will pass a >>> compilation check) .Rd files given a set of .R code? ?How about GUIs >>> that help properly format the .Rd files? ?Thanks! ?I want a basic set >>> of .Rd files that I can update as I go, but as with most things my >>> documentation typically lags behind my coding by a few days. >>> >>> --j >>> >>> -- >>> Jonathan A. Greenberg, PhD >>> Assistant Project Scientist >>> Center for Spatial Technologies and Remote Sensing (CSTARS) >>> Department of Land, Air and Water Resources >>> University of California, Davis >>> One Shields Avenue >>> Davis, CA 95616 >>> Phone: 415-763-5476 >>> AIM: jgrn307, MSN: jgrn307 at hotmail.com, Gchat: jgrn307 >>> >>> ______________________________________________ >>> R-help at r-project.org mailing list >>> https://stat.ethz.ch/mailman/listinfo/r-help >>> PLEASE do read the posting guide >>> http://www.R-project.org/posting-guide.html >>> and provide commented, minimal, self-contained, reproducible code. >> >> > > > > -- > Jonathan A. Greenberg, PhD > Assistant Project Scientist > Center for Spatial Technologies and Remote Sensing (CSTARS) > Department of Land, Air and Water Resources > University of California, Davis > One Shields Avenue > Davis, CA 95616 > Phone: 415-763-5476 > AIM: jgrn307, MSN: jgrn307 at hotmail.com, Gchat: jgrn307 > > ______________________________________________ > R-help at r-project.org mailing list > https://stat.ethz.ch/mailman/listinfo/r-help > PLEASE do read the posting guide http://www.R-project.org/posting-guide.html > and provide commented, minimal, self-contained, reproducible code. >
For the initial .Rd file look at the 'prompt' function, it will create a basic .Rd file based on the current function definition with all the structure in place, then you go in and edit it to have more meaningful information. -- Gregory (Greg) L. Snow Ph.D. Statistical Data Center Intermountain Healthcare greg.snow at imail.org 801.408.8111> -----Original Message----- > From: r-help-bounces at r-project.org [mailto:r-help-bounces at r- > project.org] On Behalf Of Jonathan Greenberg > Sent: Tuesday, August 23, 2011 5:55 PM > To: r-help > Subject: [R] Easier ways to create .Rd files? > > R-helpers: > > Are there any ways to auto-generate R-friendly (e.g. will pass a > compilation check) .Rd files given a set of .R code? How about GUIs > that help properly format the .Rd files? Thanks! I want a basic set > of .Rd files that I can update as I go, but as with most things my > documentation typically lags behind my coding by a few days. > > --j > > -- > Jonathan A. Greenberg, PhD > Assistant Project Scientist > Center for Spatial Technologies and Remote Sensing (CSTARS) > Department of Land, Air and Water Resources > University of California, Davis > One Shields Avenue > Davis, CA 95616 > Phone: 415-763-5476 > AIM: jgrn307, MSN: jgrn307 at hotmail.com, Gchat: jgrn307 > > ______________________________________________ > R-help at r-project.org mailing list > https://stat.ethz.ch/mailman/listinfo/r-help > PLEASE do read the posting guide http://www.R-project.org/posting- > guide.html > and provide commented, minimal, self-contained, reproducible code.