Beliebige Abschnitte in Sauerstoffdokumenten

Die Art und Weise, wie Roxygen zu funktionieren scheint, ist, dass die erste Zeile die ist \title, alles andere in der \details, und dann alle @fooAnweisungen diese Dinge behandeln. Die R-Dokumentation ist jedoch umfangreicher. ich kann haben"\section{Llamas}{Are they ungulates?}" in .Rd-Dateien haben.

Aber ich kann Roxygen nicht dazu bringen, etwas anderes zu tun, als alles in Details zu packen. Vermisse ich etwas

Ich habe eine hackige Lösung, die darin besteht, eine unübertroffene }vor meine zu stellen \section. Dies beendet dann den \detailsAbschnitt. Ich muss dann kein Ende setzen }, weil Sauerstoff einen in dem Gedanken festhält, dass es das schließt \details. Eeeeeurrrrrrrrgh.

r roxygen

— Spacedman
quelle

Ausgezeichnete Frage. Ich vermute, Sie haben Recht, dass dies im Moment nicht möglich ist. Aber Hadley Wickham hat kürzlich erwähnt, dass er den Schlüssel zur zukünftigen Entwicklung von Sauerstoff hält, und ich hoffe, dass in naher Zukunft etwas Erstaunliches auftauchen wird.

— Andrie

Je nachdem, wie ausführlich Sie sein möchten, können Sie Hadley anbieten, ihm bei seiner Arbeit zu helfen. Ich weiß, dass seine Arbeit erstaunlich ist, aber schließlich: "Vell, er ist nur ein Typ, weißt du?". Vielleicht möchten Sie den Code lesen, den Hadley unter github github.com/hadley/roxygen veröffentlicht hat, und ihm vielleicht eine E-Mail senden und ihn fragen ...

— PaulHurleyuk

Sicher. Ich habe Hadley auch hier gesehen, damit er es weiß. Zuerst dachte ich, ich hätte etwas in den Dokumenten verpasst, wie eine "@section Llamas" -Richtlinie oder ähnliches.

— Spacedman

Ich mag Lamas. Das ist alles.

— JD Long

Siehe das @sectionTag in roxygen2

— hadley

Diese Unterstützung wurde hinzugefügt (zumindest in roxygen2). Sie müssen nur hinzufügen, @section Llamas:und alles, was danach passiert, bis eine neue Anweisung erfüllt ist, befindet sich in einem Lamas-Abschnitt. Hier ist ein Beispiel

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

Dies gibt Folgendes für die .Rd-Datei

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

— Dason
quelle