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

时间:2012-02-08 21:27:31

标签: r roxygen roxygen2

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

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

(或者至少我不够聪明,以避免逃避报价)。虽然此命令在R中正常工作,但roxygenize / document函数将其转换为双重转义

  msearch("published_in:\\"Journal of Ecology\\"")
.Rd文件中的

。我该如何解决这个问题?

2 个答案:

答案 0 :(得分:3)

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

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

*。Rd文件

中转换为此内容
msearch("published_in:\\"Journal of Ecology\\"")

正在成为以下各种帮助文件格式

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

我猜这是你在最终产品中真正想要的东西。正如它在许多其他方面所做的那样,roxygen简化了编写帮助文件的过程 - 在这种情况下,您可以在{I}}中键入您希望它们实际显示的位置。它是通过转义\来实现的(就像你不得不这样做),这是你在偷看\文件时所看到的。

答案 1 :(得分:0)

你需要问问自己这是否真的代表了一个问题。在R-help中经常提出一个问题,即为什么这是真的:

nchar("\n") == 1

还提出了关于如何删除不需要的“\”的进一步问题....其中真的不存在。

如果你想在字符串中使用双引号,那么可能使用单引号来侧翼它?或者考虑tidy.source函数:http://finzi.psych.upenn.edu/R/library/formatR/html/tidy.source.html