r - 在 R 中的 roxygen 文档中转义引号

Question

我的文档中有一个需要转义引号的 R 函数示例：

#' @examples msearch("published_in:\"Journal of Ecology\"")

（或者至少我不够聪明，无法避免转义引用）。虽然此命令在 R 中正常工作，但 roxygenize/document 函数将其转换为双转义

  msearch("published_in:\\"Journal of Ecology\\"")

在 .Rd 文件中。我该如何解决这个问题？

Answer 1

如您所见，roxygen 文档块中的以下行

#' @examples msearch("published_in:\"Journal of Ecology\"")

在*.Rd 文件中转换为此

msearch("published_in:\\"Journal of Ecology\\"")

在成为以下各种帮助文件格式的过程中

msearch("published_in:\"Journal of Ecology\"")

我猜这就是你在最终产品中真正想要的。正如它在许多其他方面所做的那样，它roxygen正在简化编写帮助文件的过程——在这种情况下，通过让您\在您希望它们实际出现的地方键入 s。它通过转义\s 来做到这一点（否则你必须这样做），这是你在窥视*.Rd文件时看到的。

Answer 2

你需要问问自己这是否真的代表了一个问题。在 R-help 中，经常提出一个关于为什么这是 TRUE 的问题：

nchar("\n") == 1

并提出了有关如何删除不需要的“\”的进一步问题....确实不存在。

如果您想在字符串中使用双引号，那么也许使用单引号将其放在两侧？或者考虑 tidy.source 函数：http ://finzi.psych.upenn.edu/R/library/formatR/html/tidy.source.html