Sections arbitraires dans les docs de roxygen

Question

La manière Roxygen semble fonctionner est que la première ligne est la \title tout le reste est dans le \details et ensuite n'importe quel @foo se chargent de ces choses. Mais la documentation de R est plus riche que cela. Je peux avoir "\section{Llamas}{Are they ungulates?}" dans les fichiers .Rd.

Mais je n'arrive pas à faire en sorte que Roxygen fasse autre chose que d'emballer tout ça dans \details. Est-ce que j'ai manqué quelque chose ?

J'ai une solution astucieuse, qui consiste à coller un élément non apparié } avant mon \section . Cela met alors fin à la \details section. Je dois ensuite ne pas mettre de fin } parce que la roxygène en colle une en pensant qu'elle ferme la porte. \details . Eeeeeurrrrrrrrgh.

Answer 1

Ce support a été ajouté (au moins dans roxygen2). Il suffit d'ajouter @section Llamas: et tout ce qui suit, jusqu'à ce qu'une nouvelle directive soit respectée, sera dans une section Llamas. Voici un exemple

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

ce qui donne le résultat suivant pour le fichier .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.
}