s3出现在roxygen2生成的文档中的方法

时间:2018-06-07 19:18:39

标签: r roxygen2

通常,Usage生成的文档文件中的roxygen2部分只显示函数及其参数。但是,这个插入一行以## S3 method for class开头的文本。然后它会拆分函数的名称,留下该行的一部分,其余部分留在以下行中。我如何让它停止这样做?

代码:

#' @title t punk 5
#' @description Bar the foo
#' @param m1 mean of the sample
#' @param s1 the sample standard deviation
#' @param n1 the size of the sample
#' @param m0 the null value for foo. Default is 0.
#' @return list of length 4 
#' @note This is some random stuff.
#' @examples
#' x1 = rnorm(10)
#' t.punk5( mean(x1), sd(x1), 100, 200)
t.punk5 <- function(m1, s1, n1, m0 = 0){
  dat = m1 + s1 + n1 + m0
  return(dat) 
} # /function

输出:

t.punk5 documentation snapshot

0 个答案:

没有答案