2017-05-08 36 views
2

是否可以使用roxygen2使用非ASCII字符(例如å,ä,ö)在R中编写文档?我在问,因为我正在编写一个包含瑞典语内部函数的程序包。是否有可能使用非ASCII字符与roxygen2编写包文档?

我必须使用roxygen写文档使用下面的代码:

#' @param data data frame där variablen finns 
#' @param x variabeln, måste vara en av typen character 

这将导致扭曲的非ASCII字符。我可以手动更改.Rd文件,但我宁愿不要。

+1

我打算使用的LaTeX宏如'\ r建议{A}'为(https://en.wikibooks.org/wiki/LaTeX/Special_Characters#Escaped_codes),但这些似乎并没有被R CMD INSTALL识别 - 我想知道是否有一个选项“激活”这些宏... – ms609

回答

1

对于Rhttps://cran.r-project.org/doc/manuals/r-release/R-exts.html#Package-subdirectories),使用非ASCII字符非常困难。

代码文件中只能使用ASCII字符(和控制字符选项卡,换页符,LF和CR)。其他字符在评论13中被接受,但是然后评论可能在例如一个UTF-8语言环境。在安装软件包时,对象名称中的非ASCII字符通常会失败。任何字节都将被允许在带引号的字符串中,但\ uxxxx转义符应该用于非ASCII字符。但是,非ASCII字符串在某些语言环境中可能不可用,并且可能在其他语言中显示不正确。

对于文档,您必须将标签@encoding UTF-8添加到您的roxygen2代码中。

您可以使用以下命令检查标签是否已成功使用\uxxxx转义符。

path <- "path to Rd file" 
tools::checkRd(path)