在R文档文件中,如何在子节中包含列表

时间:2016-12-01 17:50:40

标签: r roxygen

我有一些像这样工作的氧气

#' @return
#' \subsection{foo} {
#'    \item{bar}{all about bar}
#' }

和R死于此说它不知道宏\项目。如果我删除该小节,它就可以工作。

#' @return
#'    \item{bar}{all about bar}

这可行。

有没有办法让我的酒吧项目在小节?

1 个答案:

答案 0 :(得分:0)

在@return中,存在source ~/.bash_profile 中断的隐含\describe环境。

这可以工作

\subsection

请参见#' @return #' \subsection{foo} { #' \describe{ #' \item{bar}{all about bar} #' } #' } https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Documenting-functions中的2.2.1节“文档功能”,其中的内容为:“请注意,\ value隐式是一个\ describe环境,因此不应将环境用于列出组件。 ,仅是单个\ item {} {}条目。”