如何为自己的包创建帮助文件？

我已经为每个功能创建了自己的包含描述文件和帮助文件的包。现在如果我编码?mypackage::myfunction R显示帮助文件到myfunction。但是，当我的代码?mypackage R显示“在指定的包和库‘mypackage的’没有文件：” :(如何为自己的包创建帮助文件？

来源

2017-08-02 W W

查看您最喜爱的软件包的文件结构。它应该有'pkgname-package.Rd'文件，或者它只是使用'\ alias {pkg-package}'别名。例如，这里[这里]（https://github.com/Rdatatable/data.table/blob/1f0e268f98eab93c9d5755edbaf9ff978459ce4f/man/data.table.Rd）。 –

@RomanLuštrik我用'roxygen2'创建了文档，在'man'文件夹里我可以看到'.Rd'文件的功能，但是没有这个文件。所以没有'mypackage.Rd'。 –

假设你正在使用Roxygen2生成您的文档，地方你需要像这样保存在.R文件。

#' Title 
#' 
#' Description 
#' 
#' @docType package 
#' @name varbinq 
NULL

这将为你的包，可当你输入?varbinq

欲了解更多信息，请参阅的this section访问的帮助文件Hadley Wickham的书名为R Packages。

来源

2017-08-02 07:38:21 nathaneastwood

假设Roxygen正在用于生成Rd文件 – baptiste

是的，好点 – nathaneastwood

如果您没有使用roxygen2（但您可能应该），则需要创建一个带有一般必填字段的.Rd文件，其中包括\docType{package}。请参阅Writing R Extensions的第2.1.4节。

除了强制性\名称和\冠军和PKGNAME包别名，包概述页面的唯一要求是，它包括\ {DOCTYPE包}语句。所有其他内容是可选的。我们建议它应该是一个简短的概述，给读者一个不熟悉包的信息，以便开始使用。更多将大量文档放入包装小插图（请参阅编写包装小插件）并从此页面引用或放入函数，数据集或类的单独手册页中。

来源

2017-08-02 07:49:48

-1

如果您使用的是roxygen2包记录你的包被称为“mypackage中”，该documented way做，这是在一个名为“mypackage.R”文件编写代码：

#' Generate R documentation from inline comments. 
#' 
#' Roxygen2 allows you to write documentation in comment blocks co-located 
#' with code. 
#' 
#' The only function you're likely to need from \pkg{roxygen2} is 
#' \code{\link{roxygenize}}. Otherwise refer to the vignettes to see 
#' how to format the documentation. 
"_PACKAGE"

你然后将能够使用以下方式检索您的软件包的帮助页面：

??mypackage

来源

2017-08-02 07:51:12

我已经发布了这个答案 – nathaneastwood

不，你的答案是不同的。在我看来，不如我的好。我的答案直接来自** current ** roxygen2小插曲，包含一个链接，并提及文件名。你的，虽然它可能工作没有在小插曲中提到，但是更加冗长，没有提到保存代码的位置，在编辑之前没有链接，并且在编辑之前没有提及roxygen2依赖关系。 –

如何为自己的包创建帮助文件？

回答

相关问题