我正在编写一个名为的包foo
,该包定义了foo
使用各种S3方法命名的S3类。我已经编写了一个foo()
返回foo
对象的构造函数。以包命名,以类命名函数,以类命名函数,这似乎是可行的,我希望:
package?foo
将显示软件包帮助页面。?foo
并?foo::foo
会弹出功能帮助页面。但是发生的是:
package?foo
并?foo
显示软件包帮助页面。?foo::foo
出功能帮助页面。有没有一种方法可以使程序包和函数具有相同的名称,以产生所需的行为?
目前,我有一个foo_package.R
像这样的文件:
#' The foo package
#'
#' A very useful package.
#'
#' @docType package
#' @name foo
NULL
和这样的文件foo.R
:
#' The foo function
#'
#' A very useful function.
#'
#' @param x A data frame.
#' @return A foo object.
#' @export
foo <- function(x) {
structure(x, class = c("foo", "data.frame"))
}
任何提示表示赞赏...
通过@MrFlick注释中的第二个链接(指向中的“包装”下的文本)vignette("rd")
,我能够获得预期的行为。
foo.R
未更改,但foo-package.R
现在显示为:
#' The foo package
#'
#' A very useful package.
#'
#' @docType package
#' @keywords internal
#' @aliases foo-package
"_PACKAGE"
现在,根据需要:
package?foo
并?"foo-package"
提供软件包帮助。?foo
并调?foo::foo
出功能帮助。本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句