r - roxygen 文档中的任意部分

Question

方式Roxygen似乎有效的是第一行是 \title ，其他所有内容都在 \details 中，然后任何 @foo 指令处理这些事物。但 R 文档比这更丰富。我可以在 .Rd 文件中包含 "\section{Llamas}{它们是有蹄类动物吗？}"。

但除了将其全部包装在\details 中之外，我无法让 Roxygen 做任何其他事情。我错过了什么吗？

我有一个 hacky 解决方案，即在我的 \section 之前粘贴不匹配的 } 。然后 \details 部分结束。然后我不必添加结尾 } ，因为 roxygen 认为它关闭了 \details 。呃呃呃呃呃呃。

Answer 1

已添加此支持(至少在 roxygen2 中)。您只需添加 @section Llamas: ，然后在满足新指令之前的所有内容都将位于 Llamas 部分中。这是一个例子

#' Llama llama llama
#' 
#' More about llamas
#' 
#' @section Llamas:
#' Are they ungulates?
#' 
#' @section Not llamas:
#' This section is not about llamas.  It is not very interesting.
#' 
#' @param notused A parameter that isn't used at all!
#' @export
llama <- function(notused){
    return("LLAMA LLAMA LLAMA")
}

其中给出了 .Rd 文件的以下内容

\name{llama}
\alias{llama}
\title{Llama llama llama}
\usage{
  llama(notused)
}
\arguments{
  \item{notused}{A parameter that isn't used at all!}
}
\description{
  More about llamas
}
\section{Llamas}{
  Are they ungulates?
}

\section{Not llamas}{
  This section is not about llamas.  It is not very
  interesting.
}