我正在编写一个R函数,并试图使用.Rd格式来记录该函数。我似乎找不到这方面的任何文档,所以我想知道的是如何在@retrun之后创建列表。例如,我想有一些像#' @return This list contains the following values:
R
@retrun
#' @return This list contains the following values:
a some description b some description
在@return之后需要做什么才能得到一个看起来像使用@param的列表?
@return
@param
tkclm6bt1#
我只是用这个:
#' @returns #' A list containing the following: #' #' \item{mle_params}{Maximum likelihood estimates for the parameters.} #' \item{mle_value}{The value of the log-likelihood at the maximum.}
1条答案
按热度按时间tkclm6bt1#
我只是用这个: