[R] Document related data sets.

Rolf Turner r.turner at auckland.ac.nz
Mon Nov 2 02:05:23 CET 2009


The manual on Writing R Extensions says that one should ``only  
document a
***single*** data object per Rd file''.  My recollection is that in the
past this commandment (which I occasionally found to be inconvenient)
was enforced.

I recently saw a post to R-help which appeared to indicate that one
***can*** document multiple (presumably related) data sets in a single
Rd file.  I experimented and found that the construction

\usage{
   melvin
   clyde
   irving
   fred
}

which I recollect as *not* working, now appears to work.  This in
effect permits one to document (conveniently) melvin, clyde, irving,
and fred in one data file.  Along with, of course, having

\alias{melvin}
\alias{clyde}
\alias{irving}
\alias{fred}

under the \name{ } field at the top of the file.)

	(a) Has the situation indeed changed, or is my ageing
	memory playing tricks on me again?

	(b) If indeed the situation has changed (or perhaps even
	if it hasn't) shouldn't that line ``only document a ***single***
	data object per Rd file'' be deleted from ``Writing R Extensions''?

	cheers,

		Rolf Turner

######################################################################
Attention:\ This e-mail message is privileged and confid...{{dropped:9}}




More information about the R-help mailing list