[Rd] documentation omission in Extract.Rd?

From: Tony Plate <tplate_at_acm.org>
Date: Mon, 30 Nov 2009 21:59:25 -0600


The help file for "[<-" (and "[[<-" doesn't contain those functions in it's usage section ( .../src/library/base/man/Extract.Rd ). Although that file lists "[<-" and "[[<-" as aliases, it doesn't document them in a formal manner (consequently, the "value" argument is not described in the "arguments" section.)

Is this an oversight, or are those documented elsewhere? In contrast, src/library/base/man/Extract.factor.Rd does contain the replacement forms in its usage section (as does Extract.data.frame.Rd)

Also, Extract.Rd uses forms like "x[i, j, \dots , drop = TRUE]" in the usage section, while Extract.factor.Rd uses the "method" syntax:
"\method{[}{factor}(x, \dots, drop = FALSE)". Is this because the
"method" syntax is not appropriate for the default methods that are
documented in Extract.Rd, or is the source of the docs not up-to-date with the latest Rd syntax? I ask because I was looking for examples of how to write documentation for extraction and replacement functions.

This is based on looking at the source code at http://svn.r-project.org/R/trunk/src/library/base/man/Extract.Rd and I see the same in R-2.10.0 for Linux.


R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Tue 01 Dec 2009 - 04:04:31 GMT

This archive was generated by hypermail 2.2.0 : Tue 01 Dec 2009 - 06:20:53 GMT