【发布时间】：2016-06-18 12:39:48
【问题描述】：
我正在编写一个 R 包，并且正在使用 roxygen2 记录我的所有函数。但是，我不希望所有功能都出现在包的手册中。 我如何指定哪些功能应该出现在包手册中，哪些不应该出现？
我知道用前导点命名函数，例如.f <- function() 而不是 f <- function() 是一种解决方案。还有其他解决方案吗？
【问题讨论】：
-
如果您不希望它们出现在手册中，为什么要记录它们？
-
因为它对我回忆函数的作用以及其他可能想要使用“隐藏”函数的人都很有用。我相信我在其他包中看到了一些示例，其中我在导入包后在控制台中写
?function_name找不到该函数的帮助页面，但是如果我写?pkgname:::function_name，我能够看到帮助页面。不过我可能记错了。 -
但是使用
:::访问的函数不会从包中导出——这通常意味着作者不打算让客户端使用该函数。通常，此类功能没有记录在案 - 例如tools:::.is_ASCII。我猜如果你遇到一个确实有文档的非导出函数，很可能它以前是一个导出的（和记录的）函数，并在以后的版本中从导出列表中删除。 -
如果您按照设计使用包，导出或未导出的函数将通过 roxygen2 创建一个
man/文档。我做你所描述的方式是不在评论中包含引用，所以 roxygen 不会接受它。例如需要帮助文件：#' @param ...不需要帮助文件# @param ...Here's an example
标签： r documentation package roxygen2