r - 用deqn和roxygen记录方程式

Question

我正在使用带有roxygen2的\deqn{}{}来记录包中函数的方程式。 LaTeX(deqn的第一个参数)的渲染效果很好，因为在LaTeX方程中忽略了空格，但是我对ASCII(deqn的第二个参数)表示有疑问。

问题是我的格式被破坏(roxygen似乎将整个deqn命令放在“单行”上，然后将该行换成〜60列左右)。有没有办法强制roxygen2在.R文件的roxygen命令/注释中保留空白格式？

我在文件example.R中包含以下代码:

#'Example
#'
#'deqn ASCII example
#'
#'\deqn{ \sigma = \sqrt{ \frac{Z}{n} \sum
#'  \left[ \textstyle\frac{1}{2}\displaystyle
#'    \left( \log \frac{H_i}{L_i} \right)^2  - (2\log 2-1)
#'    \left( \log \frac{C_i}{O_i} \right)^2 \right] }
#'}{sqrt(N/n * runSum(0.5 * log(OHLC[,2]/OHLC[,3])^2 -
#'           (2*log(2)-1) * log(OHLC[,4]/OHLC[,1])^2, n))}
#'
#'@param x An example parameter
#'@return A example result
#'@author Joshua Ulrich
#'@keywords ts
#'@export
"example" <-
function(x) {
}

我使用以下R代码生成 example.Rd文件:

library(roxygen2)
setwd("dir/containing/example.R/")
dir.create("man",FALSE)
roclet <- rd_roclet()
roc_proc(roclet, "example.R", ".")
roc_out(roclet, "example.R", ".")

您可以在命令行上使用以下命令生成example.Rd文件的文本表示形式:

R CMD Rd2txt dir/containing/example.R/man/example.Rd

上面命令的输出的Details部分如下所示:

sqrt(N/n *
  runSum(0.5 * log(OHLC[,2]/OHLC[,3])^2 - (2*log(2)-1) *
  log(OHLC[,4]/OHLC[,1])^2, n))

而我希望它看起来像:

sqrt(N/n * runSum(0.5 * log(OHLC[,2]/OHLC[,3])^2 -
         (2*log(2)-1) * log(OHLC[,4]/OHLC[,1])^2, n))

Answer 1

According to Hadley Wickham，换行符将在以后的roxygen版本中删除。因此，roxygen2的解决方案是对文件(或程序包)进行重新充电，然后手动更新受影响的.Rd文件中的文本方程式。