Bug 15272 - ?nclass doesn't find the nclass help page
Summary: ?nclass doesn't find the nclass help page
Status: NEW
Alias: None
Product: R
Classification: Unclassified
Component: Documentation (show other bugs)
Version: R-devel (trunk)
Hardware: All All
: P5 enhancement
Assignee: R-core
URL:
Depends on:
Blocks:
 
Reported: 2013-04-13 21:00 UTC by Richard Cotton
Modified: 2013-04-14 13:21 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Richard Cotton 2013-04-13 21:00:53 UTC
Typing "?nclass" at the R command line throws the following error:

No documentation for ‘nclass’ in specified packages and libraries:
you could try ‘??nclass’

This means that to find out which algorithms are available for automatically determining the number of bins for a histogram, you need to type "?nclass." and then autocomplete to find the name of an algorithm, and then complete the name, which is clunky.

Adding the line 

\alias{nclass}

to

src/library/grDevices/man/nclass.Rd

should fix the issue.
Comment 1 Duncan Murdoch 2013-04-14 12:36:43 UTC
There is no object called "nclass", there is just a help page called "nclass".  It would make more sense to search on help page names than to manually edit all those pages where the help page title is not used as an alias.  (There are about 90 such pages in the base packages, many more on CRAN.)
Comment 2 Peter Dalgaard 2013-04-14 13:21:41 UTC
There's no object called Syntax either, but ?Syntax does bring up the page of that name. 

Writing R extensions has:

Note that the \name is not necessarily a topic documented, and if so desired it needs to have an explicit \alias entry (as in this example). 

I think this has come up before, but I have long forgotten what the rationale might be for not having \name imply \alias. 

In the case at hand, I don't see a compelling reason against having nclass as a help topic.