Verbatim output in roxygen2 package documentation

8
votes

I am using roxygen2 from within RStudio to generate package documentation. How do I force the following in the @description section to appear as verbatim fixed-font?

SettingID    Value    
RedItem      Patient_10574    
GreenItem    Record_433

My workaround is to put it into @examples \dontrun{}, but that's not what I want.

@Joshua Ulrich found a (non-)solution to here

1
rpackageroxygen2
Just an idea, what about \code{}? Can it handle multi lines? - Roman Luštrik
Clearly, \code{} was my first choice, but I could not get it to honor the verbatim layout. I thought I could use \dontrun{}, but that one is not accepted outside @examples. Maybe I have missed some trick, but I tried a few "newline" variants. - Dieter Menne
This may be the same issue I ran into here. - Joshua Ulrich
You are right; I remember having read that, but I did not make the connection. - Dieter Menne

1 Answers

3
votes

UPDATE: Wrapping is now turned off by default in roxygen2, so this should not be an issue anymore.

I have invented a new comment syntax for roxygen2 that will preserve wrapping: Comments starting with

#''

are not wrapped at all. My reference implementation hasn't received much attention yet, though...

Of course, turning off wrapping altogether is also a way to handle the problem, but I wonder how the help looks like in a command-line terminal if the developer forgets to wrap her roxygen comments... There must have been a reason why wrapping was introduced in the first place.