roxygen2包文档中的逐字输出

时间:2013-06-12 08:32:37

标签: r package roxygen2

我在RStudio中使用roxygen2来生成包文档。如何强制@description部分中的以下内容显示为verbatim fixed-font?

SettingID    Value    
RedItem      Patient_10574    
GreenItem    Record_433    

我的解决方法是将其放入@examples \ dontrun {},但这不是我想要的。

@Joshua Ulrich找到here

的(非)解决方案

1 个答案:

答案 0 :(得分:2)

  

更新:默认情况下,roxygen2中的包装现已关闭,因此这不再是问题了。

我为roxygen2发明了一种新的注释语法,它将保留包装:以

开头的注释
#''

根本没有包裹。我的reference implementation还没有received much attention,但是......

当然,turning off wrapping altogether也是处理问题的一种方法,但是我想知道如果开发人员忘记包装她的roxygen评论,那么在命令行终端中的帮助是怎样的......一定有首先介绍包装的原因。