[Rd] "Undocumented code objects" message from missing alias

From: John Maindonald <john.maindonald_at_anu.edu.au>
Date: Sun, 11 Jul 2010 18:50:14 +1000

If I omit the \alias{houseprices} from the second line of a data documentation file houseprices.Rd, R CMD check gives the warning message:


Undocumented code objects:
All user-level objects in a package should have documentation entries. See the chapter 'Writing R documentation files' in manual 'Writing R Extensions'.

I can build the package without error, but the help file for houseprices is missing. It would be good to have a message that gives a more direct indication of what is wrong.

Running R CMD check on the directory at http://www.maths.anu.edu.au/~johnm/r/packages/testpkg demonstrates the point.

John Maindonald email: john.maindonald_at_anu.edu.au phone : +61 2 (6125)3473 fax : +61 2(6125)5549 Centre for Mathematics & Its Applications, Room 1194, John Dedman Mathematical Sciences Building (Building 27) Australian National University, Canberra ACT 0200. http://www.maths.anu.edu.au/~johnm

R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Sun 11 Jul 2010 - 08:53:13 GMT

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.2.0, at Sun 11 Jul 2010 - 17:40:14 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-devel. Please read the posting guide before posting to the list.

list of date sections of archive