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

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

65得票3回答
如何使用roxygen文档化数据集?

在roxygen过程中,是否可以将.R文件包含在数据目录中? 我已经将多个.R文件放入数据目录中。当它们通过data()被调用时,它们会读取原始数据文件并执行一些转换。

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

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

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

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

20得票1回答
使用roxygen文档添加图片

在由roxygen生成的文档中包含图像是否可行?我有很多函数本质上是ggplot()的包装器,我想通过展示输出示例来记录它们。

10得票2回答
使用RUnit或roxygen编写的好例子R包有哪些?

我正在编写一个R软件包,这个软件包将由其他人使用,所以我要努力把它做好!我想使用roxygen进行文档编写和RUnit进行单元测试,但我之前没有使用过。 有哪些软件包(无论是在CRAN还是其他地方)能够很好地使用这两个工具呢?

97得票1回答
Roxygen文档中的任意部分

Roxygen似乎是这样工作的:第一行是\title,剩下的全部在\details中,而且任何@foo指令都会处理这些内容。但R文档比这更丰富。我可以在.Rd文件中使用"\section{Llamas}{Are they ungulates?}"。 但是我无法让Roxygen做除了将所有内容...

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

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

13得票1回答
Roxygen认为我写的一个函数是S3方法,所以在安装我的包时出现了错误。

我正在使用roxygen来创建自己的包。 我有一个函数会引起问题: ##' extract.sig.metadata ##' @param foo bar ##' @author me ##' @export extract.sig.metadata <- function(foo){...

18得票2回答
使用Roxygen进行R文档编写?

我发现R文档的创建和维护很重要,但也很耗时。有人用过Roxygen吗?如果用了,它是否有助于维护R包?我以前用过Doxygen,但那些项目没有R包所需的man结构。 您可以在此处找到vignette。