[英] Multiple functions in one .Rd file
Short version:我可以用roxygen
模拟stats
包中Normal
的文档吗?
Long version:我正在开发一个软件包,并试图通过在一个标题下收集具有公共输入/参数的多个函数来提高文档的可读性,这将是对该组的一般参考.每个功能仍应独立提供给最终用户.
我的灵感来自于Normal
的文档,它给出了许多与正态分布相关的方法,例如stats::dnorm()
.
当我搜索?dnorm
时,我发现帮助部分的名称是Normal
,尽管Normal
似乎不是导出的函数或对象.
我试着将以下内容放入funs.R
:
##' @rdname funs
##' @name funs
##' @aliases sum1
##' @aliases prod1
##' @title Two functions
##' @param x X
##' @param y Y
##' @return sum1 returns x+y
##' \cr
##' prod1 returns x*y
##' @examples
##' sum1(3,4)
##' prod1(3,4)
##' @export
sum1 <- function(x,y) x+y
##' @export
##' @rdname funs
prod1 <- function(x,y) x*y
然后我在上面跑roxygen2
.
##' @export
funs <- function(x) x
它通过了,我可以看到我想要的格式的帮助,但我正在导出一个无意义的函数,以便正确显示名称.
我不确定他们是如何用.Rdx
格式显示的,但我不确定他们是如何用stats
格式显示的.
另外,在一个相关的注释中,is Normal
是什么样的事情?
require(stats)
getAnywhere("Normal")
> no object named 'Normal' was found
Update:
@泰勒林克——恐怕这是我第一次try .这将函数合并到一个.Rd
文件中,但相关帮助的名称与第一个函数的名称相同,这正是我试图避免的:
##' sum
##' gives the sum
##' @param x X
##' @param y Y
##' @return sum1 returns x+y
##' @examples
##' sum1(3,4)
##' @rdname funs
##' @export
sum1 <- function(x,y) x+y
##' product
##' gives the product
##' @return prod1 returns x*y
##' @examples
##' prod1(3,4)
##' @rdname funs
##' @export
prod1 <- function(x,y) x*y
@Andrie——这个解决方案会导致完全相同的困难,帮助的名称与第一个函数的名称相同.
也许这是不可能的...