35得票1回答
如何在使用Roxygen2时,通过`\link{}`链接到Rd文件的特定部分?

假设我想链接到函数foo的文档中的“Details”部分,该怎么办? \link{foo:Details}似乎不起作用,那么正确的命令是什么?

34得票2回答
能否在testthat测试或run_examples()中使用R包数据?

我正在开发一个R包,使用devtools、testthat和roxygen2。在data文件夹中有几个数据集(foo.txt和bar.csv)。 我的文件结构如下: / mypackage / data * foo.txt, bar.csv / inst ...

33得票1回答
我应该如何处理R包中的“helper”函数?

背景 我编写了一个R包,现在一位合作者(最近毕业的计算机科学系新生对R不熟悉)正在编辑和重构代码。在这个过程中,他把我的函数分解成更小、更通用的函数。 他的做法很有道理,但当我使用package.skeleton()时,每个函数都有一个文件。现在,他添加了主函数依赖的函数,但这些函数可能只在函...

30得票1回答
使用Roxygen2模板标签

能否提供一个如何正确使用Roxygen2中的模板标签的例子。我已经尝试了最明显的方法(对我来说): 在我的packageName-package.R文件中: #' [... other Roxygen blocks ...] #' #' @templateVar testTempl...

26得票2回答
使用roxygen2在R包中使用源代码子目录

我想在包的源代码文件夹R中使用目录结构。例如,在我的R文件夹中,我有一个algos文件夹,其中有我想要导出和文档化的函数。然而,默认情况下,roxygen2似乎不会遍历R文件夹的子文件夹。 我尝试在位于 `R/algos/algo1.r' 的文件中使用@include关键字#' @inclu...

23得票1回答
通过Roxygen添加useDynLib

我正在使用roxygen2包将我的软件包转换为使用roxygen文档。 现在,我的软件包无法加载,我认为这是由于在NAMESPACE文件中缺少useDynLib(mypackage)调用导致的。 我该如何生成这个调用?

22得票5回答
Roxygen:如何为函数设置包括反斜杠('\')的默认参数

我使用Roxygen来为正在开发的软件包生成Rd文件,但是我在默认参数设置为'\n'的函数方面遇到了一些问题,例如: lineCount <- function(text, sep='\n') { ... } 这个函数的目的是计算一个字符串中换行符 ('\n') 的...

21得票2回答
如何在roxygen文学编程中转义百分号(%)?

我的函数参数的默认值包含一个“%”符号。这似乎对roxygen造成了问题,当尝试构建latex文档时,它会产生很多警告并且R CMD check失败。 我该如何使该函数(及其文档)正常工作?使用%%或\%而不是%并没有帮助。#' Test escape \% from in-source d...

21得票3回答
如何使用roxygen正确记录S4“ [”和“ [< -”方法?

以下是我发布的一个小例子,我想为S4类的"["方法编写文档。有人知道如何使用roxygen和S4正确地记录通用方法"["的方法吗? 在构建后检查包时,我收到了警告(如下所示)。#' An S4 class that stores a string. #' @slot a contains a ...

21得票1回答
Roxygen2风格文档中如何转义“@”符号

假设我有一个注释块,在其中我想写一个电子邮件地址。我该如何转义“@”符号,以便roxygen将其视为文本而不是指令?