使用roxygen的内联包概述文档

时间:2015-12-23 16:29:22

标签: r roxygen helpfile

我想这是一个简单的事情,我一直在文档中忽略,但我似乎无法弄清楚如何在R中使用包级文档。我不是指函数或类特定的文档,但键入时获得的文档,例如?stats。

我按照我在网上找到的一般说明,创建了一个保存为.R的sckeleton文档文件。 .R文件随包脚本一起复制,但帮助文档没有被制作成.Rd文件(除非我添加了一个也以包命名的函数定义)。

我尝试过的一个例子:

#'_PACKAGE
#'MyPackage
#'
#'MyPackage description
#'
#'MyPackage details
#'@alias{MyPackage}
#'@alias{MyPackage-package}

由于某些原因,我很难找到如何设置通用包文档的好例子。我写了很多函数帮助文件,我知道我的包帮助文件是由roxygen找到的,但我不清楚为什么我不能从中生成.Rd。

1 个答案:

答案 0 :(得分:1)

在上述评论中由@slickrickulicious提供答案:

我需要在文档文件的末尾添加NULL并包含'@name MyPackage'。这样做会正确生成包帮助文件。