r - 是否可以使用 roxygen2 使用非 ASCII 字符编写包文档？

Question

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

我使用以下代码使用 roxygen 编写文档:

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

这会导致非 ASCII 字符被扭曲。我可以手动更改 .Rd 文件，但我宁愿不这样做。

Answer 1

在 Windows 上，编码在 R 中很糟糕，而且非常复杂 - 那些开发包并不总是认为这是一个真正的问题(参见 roxygen 或 devtools )。什么对我有用:

如果您的包裹中有带有非 ASCII 标签的数据，例如颜色向量 c(rød = "#C30000", blå = "#00A9E0")，你必须转义代码中的名称/值:

c(r\u00f8d = "#C30000", bl\u00e5 = "#00A9E0")

在文档中(如果您使用 roxygenize 或 devtools::document())，您必须在每个函数描述之前放置 @encoding UTF-8，然后使用常规键盘。

如果您在同一个文件中有两个功能(例如，您组织的设计包中的“调色板”和“饱和度”)，则必须在每个描述块中放置标签，而不仅仅是一次。

示例:

    #' @encoding UTF-8
    #' datastruktur for å definere firmapalett med æøå
    dummypalett <- structure(.Data = c("#c30000", "#00A9E0"),
                   names = c("r\u00f8d", "bl\u00e5"))

    #' @encoding UTF-8
    #' neste funksjon som er beskrevet med æøåäö

为了更好的衡量，我放置了 语言: nob 在描述文件中，并将 Rprofile 中的编码标签更改为“UTF-8”。