I am still researching my best choices.
IMHO, every programming and every typesetting language ever invented
should have had a compatible basic escape sequence built in. simple.
just compatible with one another. something like a specific escape
sequence on the first column, like
#%@@==R
On 02/07/2013 05:00 AM, r-help-requ...@r-project.org wrote:
I'd argue that there's an important distinction between documenting a
function (how to use it) vs. documenting an algorithm (how it works).
I think noweb can work well for describing how something works, but
it's not so good for
On 13-02-05 7:43 PM, ivo welch wrote:
Dear R experts---
after many years, I am planning to give in and write my first R
package. I want to combine my collection of collected useful utility
routines.
as my guide, I am planning to use Friedrich Leisch's Creating R
Packages: A Tutorial from Sep
Other people have recommended Roxygen, but honestly I haven't seen a package
documented with Roxygen where the documentation was adequate.
It looks as though it's great to get initial documentation created, but does
not appear to encourage followup.
I don't think that's a problem with roxygen
On 02/06/2013 03:31 AM, Duncan Murdoch wrote:
On 13-02-05 7:43 PM, ivo welch wrote:
Dear R experts---
after many years, I am planning to give in and write my first R
package. I want to combine my collection of collected useful utility
routines.
as my guide, I am planning to use Friedrich
I have heard of people using noweb to do this, but I can't point to any
examples. I'd actually recommend against it. Good documentation files
don't
make good source files.
the compiler package in base R is, apparently, developed using noweb
On 06/02/2013 9:44 AM, Martin Morgan wrote:
On 02/06/2013 03:31 AM, Duncan Murdoch wrote:
On 13-02-05 7:43 PM, ivo welch wrote:
Dear R experts---
after many years, I am planning to give in and write my first R
package. I want to combine my collection of collected useful utility
routines.
On 06/02/2013 9:49 AM, Hadley Wickham wrote:
I have heard of people using noweb to do this, but I can't point to any
examples. I'd actually recommend against it. Good documentation files
don't
make good source files.
the compiler package in base R is, apparently, developed using noweb
a nice aspect about roxygen (and perl pod) is that it compiles into
the standard .Rd files. it's not a substitute, but a complement tool.
it may also make a good start for docs when one starts writing code,
and be eventually yanked out in favor of direct changes in the .Rd
files that it has
Dear R experts---
after many years, I am planning to give in and write my first R
package. I want to combine my collection of collected useful utility
routines.
as my guide, I am planning to use Friedrich Leisch's Creating R
Packages: A Tutorial from Sep 2009. Is there a newer or better
My short answer is to watch this video by Jeffrey Horner
http://youtu.be/ScV7XXlBZww and learn roxygen2.
And the long answer is to read the manual which has everything you
need: http://cran.r-project.org/doc/manuals/r-release/R-exts.html
Regards,
Yihui
--
Yihui Xie xieyi...@gmail.com
Phone:
thanks for the responses. this is what I have learned so far:
primarily, I need to learn roxygen2 and devtools, because they do what
I was planning to reinvent.
roxygen2 allows R users to write R code that embeds its documentation.
the .R user source file has a family semblance with POD (perl's
actually, I may have found what I was looking for in
https://github.com/hadley/devtools/wiki/Philosophy
---
Ivo Welch (ivo.we...@gmail.com)
__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting
I have a minimal package here based on roxygen2:
https://github.com/yihui/rmini
Regards,
Yihui
--
Yihui Xie xieyi...@gmail.com
Phone: 515-294-2465 Web: http://yihui.name
Department of Statistics, Iowa State University
2215 Snedecor Hall, Ames, IA
On Tue, Feb 5, 2013 at 11:49 PM, ivo welch
14 matches
Mail list logo
