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.

 library(fortunes) fodder: Don't do as I say, do as Hadley does.

-- 
blog: http://geospaced.blogspot.com/
web: http://www.maths.lancs.ac.uk/~rowlings
web: http://www.rowlingson.com/
twitter: http://twitter.com/geospacedman
pics: http://www.flickr.com/photos/spacedman

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


[Rd] Is xtable still being maintained?

2011-09-10 Thread Alastair
Hi,

I wonder if anyone knows if the xtable package is still actively being
maintained? The last update to the CRAN was about 2 years ago. Earlier in
the year I found I wanted to use the short caption option of LaTeX tables to
display an abridged title in my table of contents. It was a relatively
simple change to get xtable to support this. I bundled up my changes and
sent the maintainer David B. Dahl an email and I got absolutely no response?
What's the etiquette for this kind of situation? I think he's done a
sterling job maintaining a really useful package; I wanted to help and
contribute to the community but if he's not doing it anymore how can anyone
get their improvements / bug fixes into circulation?

Cheers,
Alastair

--
View this message in context: 
http://r.789695.n4.nabble.com/Is-xtable-still-being-maintained-tp3803657p3803657.html
Sent from the R devel mailing list archive at Nabble.com.

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] Is xtable still being maintained?

2011-09-10 Thread Uwe Ligges



On 10.09.2011 13:26, Alastair wrote:

Hi,

I wonder if anyone knows if the xtable package is still actively being
maintained? The last update to the CRAN was about 2 years ago. Earlier in
the year I found I wanted to use the short caption option of LaTeX tables to
display an abridged title in my table of contents. It was a relatively
simple change to get xtable to support this. I bundled up my changes and
sent the maintainer David B. Dahl an email and I got absolutely no response?


Try to ping - at least I do so in this case. No response would be 
unfortunate, of course.




What's the etiquette for this kind of situation? I think he's done a
sterling job maintaining a really useful package; I wanted to help and
contribute to the community but if he's not doing it anymore how can anyone
get their improvements / bug fixes into circulation?


xtable's DESCRIPTION file says

License:GPL (= 2)

so go ahead in case you do not get a response.

Best,
Uwe Ligges




Cheers,
Alastair

--
View this message in context: 
http://r.789695.n4.nabble.com/Is-xtable-still-being-maintained-tp3803657p3803657.html
Sent from the R devel mailing list archive at Nabble.com.

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] Is xtable still being maintained?

2011-09-10 Thread Spencer Graves



On 9/10/2011 6:06 AM, Uwe Ligges wrote:



On 10.09.2011 13:26, Alastair wrote:

Hi,

I wonder if anyone knows if the xtable package is still actively being
maintained? The last update to the CRAN was about 2 years ago. 
Earlier in
the year I found I wanted to use the short caption option of LaTeX 
tables to

display an abridged title in my table of contents. It was a relatively
simple change to get xtable to support this. I bundled up my changes and
sent the maintainer David B. Dahl an email and I got absolutely no 
response?


Try to ping - at least I do so in this case. No response would be 
unfortunate, of course.



  David B. Dahl still has a web site as an Associate Professor at 
Texas AM U.




What's the etiquette for this kind of situation? I think he's done a
sterling job maintaining a really useful package; I wanted to help and
contribute to the community but if he's not doing it anymore how can 
anyone

get their improvements / bug fixes into circulation?


xtable's DESCRIPTION file says

License:GPL (= 2)

so go ahead in case you do not get a response.

Best,
Uwe Ligges



 xtable has a long list of reverse depends, imports, suggests and 
enhances, so many people clearly think it's useful.



  My preference is to encourage the maintainer(s) to migrate the 
project to R-Forge where others can help maintain it and add 
enhancements (that shouldn't break current applications) that people 
feel are generally useful.  (Not everyone responds positively to this 
kind of suggestion, but some do.)



  R-Forge also lists tabulaR, which is a comprehensive package for 
presenting quality tabular output within the R Environment. Differing 
from xtable and Hmisc, it manipulates, formats and presents tabular data 
to any R device stream, which can then be used by any structured 
format.  So far, however, I was unable to find evidence that the the 
tabulaR team has done anything for with R-Forge beyond successfully 
getting a shell created for the project.



  Good luck!
  Spencer





Cheers,
Alastair

--
View this message in context: 
http://r.789695.n4.nabble.com/Is-xtable-still-being-maintained-tp3803657p3803657.html

Sent from the R devel mailing list archive at Nabble.com.

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel




--
Spencer Graves, PE, PhD
President and Chief Technology Officer
Structure Inspection and Monitoring, Inc.
751 Emerson Ct.
San José, CA 95126
ph:  408-655-4567
web:  www.structuremonitoring.com

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] Is xtable still being maintained?

2011-09-10 Thread Jeffrey Ryan
I would be leery of just taking over as maintainer if a package still
works and passes all checks on CRAN.

My personal take is that even commercial packages ignore feature
requests, and to expect such from an OSS one is expecting too much.
Of course patches are welcomed, but they can't honestly be expected to
be committed.  Even if they are they may be a low priority for the
maintainer/author - be it for style, design, or
implementation/maintenance purposes.

My suggestion would be to continue to ask, but if that doesn't work
simply build an extension that others might be able to use with xtable
in this case (xtableExtras??). In the absolute last case I would fork
it if you feel the need and the intense desire to maintain a whole new
version.  The caveat of adding another package that duplicates, but
only adds one feature (however amazing you think), isn't likely to be
helpful to the entire R universe - in fact it is likely harmful.

my 2c
Jeff

On Sat, Sep 10, 2011 at 9:40 AM, Spencer Graves
spencer.gra...@prodsyse.com wrote:


 On 9/10/2011 6:06 AM, Uwe Ligges wrote:


 On 10.09.2011 13:26, Alastair wrote:

 Hi,

 I wonder if anyone knows if the xtable package is still actively being
 maintained? The last update to the CRAN was about 2 years ago. Earlier in
 the year I found I wanted to use the short caption option of LaTeX tables
 to
 display an abridged title in my table of contents. It was a relatively
 simple change to get xtable to support this. I bundled up my changes and
 sent the maintainer David B. Dahl an email and I got absolutely no
 response?

 Try to ping - at least I do so in this case. No response would be
 unfortunate, of course.


      David B. Dahl still has a web site as an Associate Professor at Texas
 AM U.


 What's the etiquette for this kind of situation? I think he's done a
 sterling job maintaining a really useful package; I wanted to help and
 contribute to the community but if he's not doing it anymore how can
 anyone
 get their improvements / bug fixes into circulation?

 xtable's DESCRIPTION file says

 License:            GPL (= 2)

 so go ahead in case you do not get a response.

 Best,
 Uwe Ligges


     xtable has a long list of reverse depends, imports, suggests and
 enhances, so many people clearly think it's useful.


      My preference is to encourage the maintainer(s) to migrate the project
 to R-Forge where others can help maintain it and add enhancements (that
 shouldn't break current applications) that people feel are generally useful.
  (Not everyone responds positively to this kind of suggestion, but some do.)


      R-Forge also lists tabulaR, which is a comprehensive package for
 presenting quality tabular output within the R Environment. Differing from
 xtable and Hmisc, it manipulates, formats and presents tabular data to any R
 device stream, which can then be used by any structured format.  So far,
 however, I was unable to find evidence that the the tabulaR team has done
 anything for with R-Forge beyond successfully getting a shell created for
 the project.


      Good luck!
      Spencer



 Cheers,
 Alastair

 --
 View this message in context:
 http://r.789695.n4.nabble.com/Is-xtable-still-being-maintained-tp3803657p3803657.html
 Sent from the R devel mailing list archive at Nabble.com.

 __
 R-devel@r-project.org mailing list
 https://stat.ethz.ch/mailman/listinfo/r-devel

 __
 R-devel@r-project.org mailing list
 https://stat.ethz.ch/mailman/listinfo/r-devel



 --
 Spencer Graves, PE, PhD
 President and Chief Technology Officer
 Structure Inspection and Monitoring, Inc.
 751 Emerson Ct.
 San José, CA 95126
 ph:  408-655-4567
 web:  www.structuremonitoring.com

 __
 R-devel@r-project.org mailing list
 https://stat.ethz.ch/mailman/listinfo/r-devel




-- 
Jeffrey Ryan
jeffrey.r...@lemnica.com

www.lemnica.com
www.esotericR.com

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


[Rd] control list gotcha

2011-09-10 Thread John C Nash
This is mainly a reminder to others developing R packages to be careful not to 
supply
control list items that are not used by the called package. Optimx is a wrapper 
package
that aims to provide a common syntax to a number of existing optimization 
packages.
Recently in extending optimx package I inadvertently introduced a new control 
for optimx
which is NOT in any of the wrapped optimization packages. There are probably 
other methods
of keeping things tidy, but I copy the control list and null out unwanted 
elements for
each of the called packages. I missed this in a couple of places in the R-forge
development version of optimx (I'm working on fixing these, but they are still 
there at
the moment).

The nasty here was that the package mostly works, with plausible but not very 
good
results for some of the optimizers. If it crashed and burned, it would have 
been noticed
sooner. There is also a potential interaction with a use of the dot-dot-dot 
variable to
pass scaling information.

If there are ideas on how to quickly reveal errors related to calling sequences 
involving
control lists and ..., I'd welcome them (off-list?), and be prepared to 
summarize
findings in a vignette.

Best,

JN

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


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 Ulrich  |  FOSS Trading: www.fosstrading.com




 On Fri, Sep 9, 2011 at 11:41 AM, Hadley Wickham had...@rice.edu wrote:
 | 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/

 __
 R-devel@r-project.org mailing list
 https://stat.ethz.ch/mailman/listinfo/r-devel


 __
 R-devel@r-project.org mailing list
 https://stat.ethz.ch/mailman/listinfo/r-devel


__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] control list gotcha

2011-09-10 Thread Gabor Grothendieck
On Sat, Sep 10, 2011 at 12:31 PM, John C Nash nas...@uottawa.ca wrote:
 This is mainly a reminder to others developing R packages to be careful not 
 to supply
 control list items that are not used by the called package. Optimx is a 
 wrapper package
 that aims to provide a common syntax to a number of existing optimization 
 packages.
 Recently in extending optimx package I inadvertently introduced a new control 
 for optimx
 which is NOT in any of the wrapped optimization packages. There are probably 
 other methods
 of keeping things tidy, but I copy the control list and null out unwanted 
 elements for
 each of the called packages. I missed this in a couple of places in the 
 R-forge
 development version of optimx (Iam working on fixing these, but they are 
 still there at
 the moment).

 The nasty here was that the package mostly works, with plausible but not 
 very good
 results for some of the optimizers. If it crashed and burned, it would have 
 been noticed
 sooner. There is also a potential interaction with a use of the dot-dot-dot 
 variable to
 pass scaling information.

 If there are ideas on how to quickly reveal errors related to calling 
 sequences involving
 control lists and ..., I'd welcome them (off-list?), and be prepared to 
 summarize
 findings in a vignette.



Suppose we wish to call f with the control.list components plus
those in the default.args not already specified in the control.list.
If any such arg is not an arg of f exclude it:

# test data - f, default.args and control.list
f - function(a, b, c = 0, d = 1) print(match.call())
default.args - list(a = 2, b = 1)
control.list - list(a = 1, d = 2, e = 3)

# override default.args with control.list
use.args - modifyList(default.args, control.list)

# exclude components of use.args that are not args of f
sel - names(use.args) %in% names(as.list(args(f)))
final.args - use.args[sel]

# run f
do.call(f, final.args)

The last line gives:

 do.call(f, final.args)
f(a = 1, b = 1, d = 2)

-- 
Statistics  Software Consulting
GKX Group, GKX Associates Inc.
tel: 1-877-GKX-GROUP
email: ggrothendieck at gmail.com

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] Is xtable still being maintained?

2011-09-10 Thread oliver
On Sat, Sep 10, 2011 at 07:40:24AM -0700, Spencer Graves wrote:
 
 
 On 9/10/2011 6:06 AM, Uwe Ligges wrote:
 
 
 On 10.09.2011 13:26, Alastair wrote:
 Hi,
 
 I wonder if anyone knows if the xtable package is still actively being
 maintained? The last update to the CRAN was about 2 years ago.
 Earlier in
 the year I found I wanted to use the short caption option of
 LaTeX tables to
 display an abridged title in my table of contents. It was a relatively
 simple change to get xtable to support this. I bundled up my changes and
 sent the maintainer David B. Dahl an email and I got absolutely
 no response?
 
 Try to ping - at least I do so in this case. No response would
 be unfortunate, of course.
 
 
   David B. Dahl still has a web site as an Associate Professor
 at Texas AM U.
 
 
 What's the etiquette for this kind of situation? I think he's done a
 sterling job maintaining a really useful package; I wanted to help and
 contribute to the community but if he's not doing it anymore how
 can anyone
 get their improvements / bug fixes into circulation?
 
 xtable's DESCRIPTION file says
 
 License:GPL (= 2)
 
 so go ahead in case you do not get a response.
 
 Best,
 Uwe Ligges
 
 
  xtable has a long list of reverse depends, imports, suggests
 and enhances, so many people clearly think it's useful.
 
 
   My preference is to encourage the maintainer(s) to migrate the
 project to R-Forge where others can help maintain it and add
[...]

AFAIK xtable was also there available, but looking it up via search function
it seems not to be the case.
So I may have mixed up it with a different package... hmhhh ah, I think it
was zoo-package. Hmhh, yes, I think zoo... and the r-forge zoo-package allows
rollapply() also on any data type, wheras the older r-cran zoo only allowed
rollapply() to zoo-dataytpe (at lkeast at that time when I compared both 
packages).


If Rforge is the devel-hosting platform, but R-CRAN is the platform where 
packages
should be downloadet from (at least it seems to be the default for install),
then from time to time packages should be copied to R-CRAN, so that there the
progress one day will pop up - maybe with a delay, and only hosting well tested
packages.

Something like testing and stable in Debian's distribution concept
for the R-packages.

It seems the R-Forge issue is not so well known.

First time when I heard of R-forge is some months ago,
and it was via #R channel on freenode, which I also can
recommend for fast communication.


Ciao,
   Oliver

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] Is xtable still being maintained?

2011-09-10 Thread Gabor Grothendieck
On Sat, Sep 10, 2011 at 1:19 PM, oliver oli...@first.in-berlin.de wrote:
 On Sat, Sep 10, 2011 at 07:40:24AM -0700, Spencer Graves wrote:


 On 9/10/2011 6:06 AM, Uwe Ligges wrote:
 
 
 On 10.09.2011 13:26, Alastair wrote:
 Hi,
 
 I wonder if anyone knows if the xtable package is still actively being
 maintained? The last update to the CRAN was about 2 years ago.
 Earlier in
 the year I found I wanted to use the short caption option of
 LaTeX tables to
 display an abridged title in my table of contents. It was a relatively
 simple change to get xtable to support this. I bundled up my changes and
 sent the maintainer David B. Dahl an email and I got absolutely
 no response?
 
 Try to ping - at least I do so in this case. No response would
 be unfortunate, of course.


       David B. Dahl still has a web site as an Associate Professor
 at Texas AM U.
 
 
 What's the etiquette for this kind of situation? I think he's done a
 sterling job maintaining a really useful package; I wanted to help and
 contribute to the community but if he's not doing it anymore how
 can anyone
 get their improvements / bug fixes into circulation?
 
 xtable's DESCRIPTION file says
 
 License:            GPL (= 2)
 
 so go ahead in case you do not get a response.
 
 Best,
 Uwe Ligges


      xtable has a long list of reverse depends, imports, suggests
 and enhances, so many people clearly think it's useful.


       My preference is to encourage the maintainer(s) to migrate the
 project to R-Forge where others can help maintain it and add
 [...]

 AFAIK xtable was also there available, but looking it up via search function
 it seems not to be the case.
 So I may have mixed up it with a different package... hmhhh ah, I think it
 was zoo-package. Hmhh, yes, I think zoo... and the r-forge zoo-package allows
 rollapply() also on any data type, wheras the older r-cran zoo only allowed
 rollapply() to zoo-dataytpe (at lkeast at that time when I compared both 
 packages).

That has since become the CRAN version of zoo:

 library(zoo)
 rollapply(1:10, 3, sum)
[1]  6  9 12 15 18 21 24 27
 packageVersion(zoo)
[1] ‘1.7.4’


-- 
Statistics  Software Consulting
GKX Group, GKX Associates Inc.
tel: 1-877-GKX-GROUP
email: ggrothendieck at gmail.com

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] Is xtable still being maintained?

2011-09-10 Thread Uwe Ligges
I think posting this to R-devel was a good idea. In any case, the new 
maintainer should be aware about the many dependencies and that she or 
he should be careful not to break code of others when updating.


Thank you for your contributions!!!

Best wishes,
Uwe Ligges





On 10.09.2011 19:14, David B. Dahl wrote:

Hello,

Regarding whether xtable is still maintained, yes, but at a minimal
level.  I am committed to ensuring that it passes the tests on the
latest version of R, but I am having difficulty finding the time and
interest in incorporating new features.  So, I'd be very glad if someone
would like to take over as the maintainer.  In fact, a few weeks ago I
sent the following e-mail to Kurt Hornik:

Kurt,

I am the original author and maintainer of the xtable package first
released in 2000.  Judging by the reverse dependencies and its common
use with Sweave, the popularity of my xtable far exceeded my
expectations.

xtable does everything I need (and more!), but I still get occasional
requests for new features, etc.  I find that I have little time and
interest in extending it much further.  I am happy to continue to make
sure it passes the checks with new releases of R, but I wonder if the
community would be served by a new maintainer.  I read the document
here:

http://cran.r-project.org/src/contrib/Orphaned/README

Do you have any further suggestions for a smooth transition?

-- David

--
David B. Dahl
Associate Professor
Department of Statistics
Texas AM University

Phone: 979-845-3141 tel:979-845-3141
E-mail: d...@stat.tamu.edu mailto:d...@stat.tamu.edu
Website: http://www.stat.tamu.edu/~dahl



__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


[Rd] Is xtable still being maintained?

2011-09-10 Thread David B. Dahl
Hello,

Regarding whether xtable is still maintained, yes, but at a minimal level.
 I am committed to ensuring that it passes the tests on the latest version
of R, but I am having difficulty finding the time and interest in
incorporating new features.  So, I'd be very glad if someone would like to
take over as the maintainer.  In fact, a few weeks ago I sent the following
e-mail to Kurt Hornik:

Kurt,

I am the original author and maintainer of the xtable package first
released in 2000.  Judging by the reverse dependencies and its common
use with Sweave, the popularity of my xtable far exceeded my
expectations.

xtable does everything I need (and more!), but I still get occasional
requests for new features, etc.  I find that I have little time and
interest in extending it much further.  I am happy to continue to make
sure it passes the checks with new releases of R, but I wonder if the
community would be served by a new maintainer.  I read the document
here:

http://cran.r-project.org/src/contrib/Orphaned/README

Do you have any further suggestions for a smooth transition?

-- David

--
David B. Dahl
Associate Professor
Department of Statistics
Texas AM University

Phone: 979-845-3141
E-mail: d...@stat.tamu.edu
Website: http://www.stat.tamu.edu/~dahl

[[alternative HTML version deleted]]

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


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,
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 Sat, Sep 10, 2011 at 11: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 and  spit out source files with the Roxygen
 comments in them...

 really lazy.


 That's what Rd2roxygen does...

 Best,
 --
 Joshua Ulrich  |  FOSS Trading: www.fosstrading.com


__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


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 and  spit out source files with the Roxygen
 comments in them...

 really lazy.


 That's what Rd2roxygen does...

 Best,
 --
 Joshua Ulrich  |  FOSS Trading: www.fosstrading.com




 On Fri, Sep 9, 2011 at 11:41 AM, Hadley Wickham had...@rice.edu wrote:
 | 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/

 __
 R-devel@r-project.org mailing list
 https://stat.ethz.ch/mailman/listinfo/r-devel


 __
 R-devel@r-project.org mailing list
 https://stat.ethz.ch/mailman/listinfo/r-devel



__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] Is xtable still being maintained?

2011-09-10 Thread oliver
On Sat, Sep 10, 2011 at 10:24:49AM -0700, Spencer Graves wrote:
 On 9/10/2011 10:19 AM, oliver wrote:
 On Sat, Sep 10, 2011 at 07:40:24AM -0700, Spencer Graves wrote:
 
 On 9/10/2011 6:06 AM, Uwe Ligges wrote:
 
 On 10.09.2011 13:26, Alastair wrote:
 Hi,
 
 I wonder if anyone knows if the xtable package is still actively being
[...]

long beard shaved away ;-)


[...]
 If Rforge is the devel-hosting platform, but R-CRAN is the platform where 
 packages
 should be downloadet from (at least it seems to be the default for install),
 then from time to time packages should be copied to R-CRAN, so that there the
 progress one day will pop up - maybe with a delay, and only hosting well 
 tested
 packages.
 
 Exactly:  R-Forge - (log in and select a package for which you are
 a maintainer or admin) - R packages - [Submit this package to
 CRAN] -  (answer the questions) - submit --- but only when you
 feel the new version is ready.
[...]


I think, often things become unsupported, because
too much overhead is annoying.
But this sounds very good / supporting.

Ciao,
   Oliver

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


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

2011-09-10 Thread Mark.Bravington
I create  maintain all my packages using the 'mvbutils' package. Documentation 
in plain-text format (not Rd) is stored along with each function definition--- 
so when you edit your function, its doco is right there too, and it looks like 
proper documentation, not code-comments or quasi-Latex. The entire package 
source tree, including the Rd files, is created automatically by the 
'preinstall' function, after which you can then R-BUILD the package as usual. 
However, with 'mvbutils' you only need R-BUILD when you want a distribution 
version for others. Normal maintenance doesn't require R-BUILD; you can 
add/remove/edit functions, documentation, and data to the package on-the-fly 
while it is loaded, with no need to unload/uninstall/rebuild/reload.

It works with compiled code, too. My own way of working with compiled code is a 
bit different to most other people's, but colleagues who use more traditional 
routes have also successfully used 'mvbutils' to build and maintain their 
packages.

In the spirit of several other replies-- I spent months developing this stuff 
and getting it to run smoothly, precisely because I'm lazy and have a limited 
memory...

HTH (though whether yet another approach is... will actually help you, I'm 
not sure)

Mark


Mark Bravington
CSIRO CMIS
Marine Lab
Hobart
Australia

From: r-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 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.

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?

pj

--
Paul E. Johnson
Professor, Political Science
1541 Lilac Lane, Room 504
University of Kansas

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


[Rd] Importing from a package with dependencies

2011-09-10 Thread steven mosher
 I needed to do a little cleanup on my packages ( before trying
Rd2Roxygen) and that involved
switching some packages from my Depends list  to Imports.

Specifically, I had a dependency on R.utils, but since I only used
one or two functions
(gunzip ) I thought it best to importFrom(R.utils,gunzip) in the
namespace and then switch
from depending on R.util to Importing.

However, R.utils depends upon R.oo and R.methodsS3. I removed them as
well from the depends.

Now, when I build the package I get the following warning


library or require call not declared from R.oo

I know this is something stupid I am missing.

I would like to import from R.util  because of a name clash with
raster  ( extract).

Do I still need to declare a depends on R.oo and R.methodsS3?


Thanks

Steve

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel