我使用 Roxygen 来生成我正在开发的包的 Rd 文件,但是我在默认参数设置为 ' 的函数方面遇到了一些问题\n'
,例如:
lineCount <- function(text, sep='\n') {
...
}
其目的是计算'\n'
字符串中的换行 ( ) 字符。问题是 R CMD check 给出警告:
Codoc mismatches from documentation object 'lineCount':
lineCount
Code: function(text, sep = "\n")
Docs: function(text, sep = " ")
Mismatches in argument default values:
Name: 'sep' Code: "\n" Docs: " "
在我看来,这个问题是由写入 Rd 文件引起的(通过写入标准 LaTeX 文件cat()
总是需要出于某种目的使用双转义字符,例如:\\newline
- 正如我所经历的那样)。如果我在分隔符上加上一个额外的反斜杠,例如:
lineCount <- function(text, sep='\\n') {
...
}
问题仍然存在,就像它看起来像的代码一样'\\n'
,但在文档(Rd 文件)中它看起来像'\n'
.
我的问题有简单的解决方案吗?可能是 Roxygen 中的一个额外标签,它可以定义如何将函数的参数写入 Rd 文件?抱歉,如果问了一个太明显的问题,但是在谷歌搜索了一段时间后我迷路了。
历史: http: //permalink.gmane.org/gmane.comp.lang.r.roxygen/24
更新:使用roxygen2!