40得票2回答
当我编写自己的R软件包时,似乎无法正确导入其他软件包。

好的,这是我第一次尝试编写一个R软件包,但现在卡住了。下面是我创建软件包的方式:package.skeleton("pkg",code_files=some.filenames) roxygenize("okg") 我正在使用roxygen2,并在我的"pkg-package.R"文件中使用以...

11得票2回答
通过roxygen2在R文档中生成带有多个参数的项

为了生成一个R文档文件(.Rd),我使用RStudio/Document选项来配合R 3.0.2、Linux 3.11、devtools 1.5和roxygen2 4.0.1。 目标 我想在文档文件中描述一个函数的多个参数,如下例所示:\arguments{ \item{arg1, a...

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

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

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

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

57得票2回答
Roxygen2 - 如何正确地记录 S3 方法

我已经阅读了Roxygen2 PDF和这个网站,但是我不知道@method @S3method @export之间的区别,也不知道如何使用它们来正确记录S3方法。 我已经准备了下面的示例以供讨论: 我应该如何正确记录这些内容? 如何模拟文档中 ?print 和其他通用函数的用例,这些用例显示...

8得票3回答
roxygen2和RStudio无法为函数创建文档

我正在尝试通过roxygen2在软件包中添加文档。 我能够成功创建软件包,并在加载时使用函数。 这是我的操作方式,我在RStudio上创建一个空的R软件包项目,然后有一个名为“getSomething.R”的源文件。 其内容如下: #' Test function to ask on sta...

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

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

49得票3回答
如何使用Roxygen正确记录来自不同包的通用S3方法?

我正在编写一个新类surveyor,其中定义了一个print方法print.surveyor的包。我的代码可以正常工作,并且我使用Roxygen进行内联文档记录。但是,命令R CMD check会发出警告: 在文档对象'print.surveyor'中具有用法但未在代码中出现的函数/方...

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

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

10得票1回答
如何在不将数据集添加到Collate字段的情况下记录数据集?

我正在使用roxygen2为正在开发的软件包文档化数据集。我知道可以使用roxygen文档化数据集,但是Shane的答案最终提出了一种hack方法,虽然我宁愿避免使用这种方法。因此,我的问题是: 我应该在哪里放置数据的roxygen文档? 我目前有一个数据文档文件(anorexia.sub...