Question

Roxygen似乎工作的方式是第一行是\title，其他所有内容都在\details中，然后任何@foo指令处理这些内容。但R文档比这更丰富。我可以在.Rd文件中使用"\section{Llamas}{Are they ungulates?}"。

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

我有一个hacky解决方案，就是在}之前粘贴一个不匹配的\section。然后，这将结束\details部分。然后我不得不把结尾}放进去，因为roxygen认为它会关闭\details。 Eeeeeurrrrrrrrgh。

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.
}

roxygen docs中的任意部分

1 个答案: