Re: [R] Documentation General Comments

From: hadley wickham <h.wickham_at_gmail.com>
Date: Thu, 24 Apr 2008 10:26:57 -0500

> Help files with alias or concept or title matching 'data type' using
> fuzzy matching:
> character-class(methods)
> Classes Corresponding to Basic Data Types
> sqlTypeInfo(RODBC) Request Information about DataTypes in an ODBC
> Database
>

One small, but concrete improvement to the output from help.search would be to list the functions like:

methods::character-class

                        Classes Corresponding to Basic Data Types
RODBC::sqlTypeInfo      Request Information about DataTypes in an ODBC
                        Database

and then extend ? to correctly parse (e.g.) ?methods::character-class  (although perhaps there a better display would be methods::"character-class"). This change would make function calling and accessing documentation a little more consistent.

It would also be useful to list keywords in the help documentation, so that one could more easily figure out what other documentation might be related.

Hadley

Hadley

-- 
http://had.co.nz/

______________________________________________
R-help_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.
Received on Thu 24 Apr 2008 - 15:43:57 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 Thu 24 Apr 2008 - 16:30:32 GMT.

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

list of date sections of archive