24

我正在使用\deqn{}{}roxygen2 来记录包中函数的方程。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

上述命令输出的详细信息部分如下所示：

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))
4

2 回答 2

19

根据 Hadley Wickham的说法，在 roxygen 的未来版本中将删除换行。所以 roxygen2 的解决方案是 roxygenize 文件（或包），然后手动更新受影响.Rd文件中的文本方程。

于 2013-01-09T17:17:30.117 回答
7

这个答案没有解决您的 ASCII 问题，但它目前是我在 HTML 中呈现乳胶方程式时的首选方式，所以我希望这对您有所帮助。

看看 mathjaxr 包（CRAN，GitHub）。您可以使用install.packages("mathjaxr")或安装它remotes::install_github("wviechtb/mathjaxr")。

它引入了一个宏，该宏从MathJax\loadmathjax加载必要的 JavaScript以呈现乳胶方程。然后使用宏or代替or就可以了。\mjeqn{latex}{ascii}\mjdeqn{latex}{ascii}\eqn\deqn

在您的具体示例中，我们将具有以下内容：

#' Example
#'
#' Example mathjax function
#'
#' \loadmathjax
#' \mjdeqn{ \sigma = \sqrt{ \frac{Z}{n} \sum
#'   \textstyle\frac{1}{2}\displaystyle
#'     \left\[ \left( \log \frac{H_i}{L_i} \right)^2  - (2\log 2-1) \left( \log \frac{C_i}{O_i} \right)^2 \right] }
#' }{ASCII representation}
example <- function(a, b, c) {}

（注意左方括号已转义）

\loadmathjax如果您使用 RStudio，您可能会在使用宏时遇到一些问题。要快速预览内容，请执行以下操作：

  1. 生成文档（Ctrl + Shift + D 或devtools::document(roclets = c('rd', 'collate', 'namespace'))）
  2. 致电preview_rd("example.Rd")预览文档

完成后，您可以通过以下步骤检查最终结果：

  1. 生成文档（Ctrl + Shift + D 或devtools::document(roclets = c('rd', 'collate', 'namespace'))
  2. 安装包（Ctrl + Shift + L 或devtools::install()）
  3. 重新启动R 会话.rs.restartR()
  4. 预览文档?example

无论哪种方式都应该产生以下结果：

渲染的 mathjax 方程

于 2020-05-28T10:58:29.747 回答