Secciones arbitrarias en roxygen docs

Question

La forma en que Roxygen parece funcionar es que la primera línea es \title, todo lo demás está en \details, y luego cualquier directiva @foo maneja esas cosas. Pero la documentación de R es más rica que eso. Puedo tener "\section{Llamas}{Are they ungulates?}" en archivos .Rd.

Pero no puedo hacer que Roxygen haga nada más que envolverlo todo en detalles. ¿Me estoy perdiendo de algo?

Tengo una solución hacky, que es pegar un incomparable } antes de mi \section. Esto luego finaliza la sección \details. Entonces no tengo que poner una terminación }, porque roxygen pega una al pensar que está cerrando el \details. Eeeeeurrrrrrrrgh.

Answer 1

Este soporte ha sido agregado (al menos en roxygen2). Solo tiene que agregar @section Llamas: y todo lo demás hasta que se encuentre una nueva directiva estará en la sección Llamas. Aquí está un ejemplo

#' 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") 
} 

la que dicta la siguiente para el archivo de .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. 
}