Roxygen2：@return 大括号或引号不匹配

Question

我使用的是 rowxygen2（版本 7.1.1），无法正确解析我的函数 return 列表值。输入：

#' @return A list with the following fields: 
#' \describe{
#' \item{ID}{The speaker / speaker + session identifier of the output}
#' \item{CPPS}{Smoothed Cepstral Peak Prominence value}
#' \item{HNR}{An Harmonic-to-noise estimate}
#' \item{Shim_local}{A (local) Shimmer measurement (in %)}
#' \item{Shim_local_DB}{A (local) Shimmer measurement, in decibels}
#' \item{LTAS_Slope}{The slope of the Long Time Average Spectrum (in dB)}
#' \item{LTAS_Tilt}{The Long Time Average Spectrum tilt (in dB)}
#' \item{AVQI}{Acoustic Voice Quality Index summarizing the measures above}
#' }

在通过 roxygen2 运行时给出警告“@return 不匹配的大括号或引号”，而我在 Rd 文件的“\value”字段中什么也得不到。

关于如何解决这个问题有什么想法吗？

Answer 1

那是因为“%”：

#' \item{Shim_local}{A (local) Shimmer measurement (in %)}

替换为

#' \item{Shim_local}{A (local) Shimmer measurement (in \%)}

否则，“%”后面的字符将被丢弃。

Roxygen2：@return 大括号或引号不匹配

Roxygen2: @return mismatched braces or quotes

r

return-value

documentation-generation

roxygen2