[R] Line breaks in documentation \useage

Rolf Turner rolf.turner at xtra.co.nz
Fri Jan 18 01:02:11 CET 2013


On 01/18/2013 12:33 AM, Markku Karhunen wrote:
>
>
> Hi again, R community.
>
> I wonder how you do line breaks in \useage{} section in .Rd files. I 
> am sure there's some tutorial for this somewhere, but I just haven't 
> found it.
>
> I have tried \\, \cr, \br and \newline, admittedly arbitrarily, but 
> all of these produce warnings or errors.

The \usage{} section appears to be treated "verbatim" or as if it were 
preformated.
So just put the line break "literally" in your *.Rd and it will 
automagically appear in the
resulting help.

     cheers,

         Rolf Turner



More information about the R-help mailing list