使用roxygen的内联包概述文档

我想这是一个简单的东西，我在文档中一直忽略，但我似乎无法弄清楚如何让包级文档在R中工作。我不是指函数或类特定的文档，而是键入时获得的文档，例如？stats。使用roxygen的内联包概述文档

我遵循我在网上找到的一般说明，创建一个保存为.R的sckeleton文档文件。 .R文件与软件包脚本一起复制，但帮助文档不会写入.Rd文件（除非我添加一个也以该软件包命名的函数定义）。

什么，我已经试过一个例子：

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

我有一个很难找到的如何设置一般包文件，因为某些原因很好的例子。我写了很多函数帮助文件，我知道我的包帮助文件是由roxygen找到的，但是我不清楚为什么我不能从它生成.Rd。的@slickrickulicious在上述意见

2015-12-23 Joel Graff

在你的文档之后，你确实需要一行'NULL'。 [见这里]（http://r-pkgs.had.co.nz/man.html#man-packages）为例。 –

你可能想改变你的问题的标题。这不是'整体包装文件'。你知道如何在Rd文件中做到这一点 - 这是关于roxygen2的一个特定方面。 –

@slickrickulicious同意。试试'相同（NULL，{}）'看看为什么这两个工作同样好。 –

回答礼貌：

我需要在我的文档文件的末尾添加NULL和包括“@name MyPackage的”。这样做会正确生成软件包帮助文件。

2015-12-23 17:11:14

回答