[SVN] r5386 (R)

[Charilaos Skiadas]

On Oct 19, 2006, at 10:15 PM, hadley wickham wrote:

> It's probably been too long since I learnt R to be of much use - most
> of the common stuff is built into my muscle memory by now.   Perhaps
> the R reference card (http://www.rpad.org/Rpad/R-refcard.pdf) would be
> a good place to start?
>
That is indeed a great summary of the key commands! I'll see what I  
can do with those.

>> What I've been thinking is, for more obsure commands, to have
>> something like the "Insert Command Template" command, except with a
>> shorter list of commands, and with explanations for each command, so
>> that people could search for them with keywords. Then perhaps we
>> could put those in a Markdown document, so that a cheatsheet could
>> show up on demand.
>
> That's a nice idea, and would be fairly easy to generate automatically
> from the built in help.  If you let me know what format you are
> thinking of, I can probably help you extract it from the
> documentation.

Basically, I am thinking it should be something fairly simple. Here  
is the typical structure I am envisioning, for the file that will  
contain the information:

sum(x)                 <---- This line is simply the syntax for the  
command. It will be used to create snippets.
#    This line contains a one line summary of what the command does.  
This will be showing up as the explanation for the command.
#                          <------- One empty comment line for clarity
#    These lines should describe what the command does, what the  
parameters need to be etc
#    They can be as many as we want. These will be providing a more  
detailed usage information.
#    I am thinking of them as a condensed version of all the  
explanations in the online help.
#    Example: perhaps an example of a call could be placed here. All  
examples should be preceded
#    by the Example: keyword.
The next command goes here.

Haris