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

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

12得票1回答
Roxygen2 - 如何 @export 引用类生成器?

例如,假设我有一个名为Test的包,我想要导出类A: For instance, say I have the following package called Test and I want to export class A:# In /R/Test.R: #' @docType pa...

14得票1回答
如何使用Roxygen2添加类专属的别名而不是通用的别名?

一个简单的例子是,我创建了一个扩展 show 的 S4 基础方法。我不想通过重新记录 show 来引起歧义分支,并且我还想通过为新类 myPkgSpClass 添加别名 show,myPkgSpClass-method,将我的扩展文档整合到 show 的文档中。#' @export #' @a...

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

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

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

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

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

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

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

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

43得票4回答
在更新软件包的新版本中重命名函数时,有最佳/推荐实践要遵循吗?

我正在更新一个旧软件包,并缩短了一些非常长的函数名称。如何让用户知道旧函数已被弃用? 我使用 roxygen2 记录所有内容,所以我想知道是否应该使用 #' @alias ? 你有什么想法吗?

21得票1回答
数据集的自动文档化

我目前正在一个项目中工作,其中我一直在从许多不同的来源慢慢积累大量不同的变量。作为一个比较聪明的人,我为每个变量创建了一个不同的子目录,在主目录“original_data”下,并包括了一个.txt文件,其中包含了我获取数据的URL和其他描述。但是,作为一个不够聪明的人,这些.txt文件没有结...

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

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