Arbitralne sekcje w dokumentach roxygen

93

Sposób, w jaki wydaje się działać Roxygen, polega na tym, że pierwsza linia to \title, wszystko inne jest w \details, a następnie wszelkie @foodyrektywy obsługują te rzeczy. Ale dokumentacja R jest bogatsza niż to. Mogę mieć "\section{Llamas}{Are they ungulates?}"w plikach .Rd.

Ale nie mogę zmusić Roxygen do zrobienia czegokolwiek innego niż zawinięcie wszystkiego w \ szczegóły. Czy coś mi brakuje?

Mam hacky rozwiązanie, jakim jest przyklejenie niezrównanego }przed moim \section. To kończy \detailssekcję. Nie muszę wtedy kończyć końcówki }, ponieważ roxygen utknie w myśleniu o zamknięciu \details. Eeeeeurrrrrrrrgh.

r roxygen Spacedman
źródło
2
Świetne pytanie. Podejrzewam, że masz rację, że w tej chwili nie można tego zrobić. Ale Hadley Wickham niedawno wspomniał, że to on jest kluczem do przyszłego rozwoju roxygen, więc mam nadzieję, że w najbliższej przyszłości pojawi się coś niesamowitego.
Andrie
4
W zależności od tego, jak bardzo chcesz uzyskać szczegółowe informacje, możesz zaoferować Hadleyowi pomoc w tym, co robi. Wiem, że jego praca jest niesamowita, ale w końcu „Vell, to po prostu zis facet, wiesz?”. Możesz przeczytać kod, który Hadley opublikował na github github.com/hadley/roxygen i może wysłać mu e-mail i zapytać go ...
PaulHurleyuk
1
Pewnie. Widziałem tu też Hadley, więc może być świadomy. Na początku myślałem, że przeoczyłem coś w dokumentacji, na przykład dyrektywę „@section Llamas” lub podobną.
Spacedman
6
Z pewnością lubię lamy. To wszystko.
JD Long
3
Zobacz @sectiontag w roxygen2
hadley,

Odpowiedzi:

22

To wsparcie zostało dodane (przynajmniej w roxygen2). Musisz tylko dodać, @section Llamas:a wszystko po tym, aż nowa dyrektywa zostanie spełniona, będzie w sekcji Lamy. Oto przykład

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

co daje następujące informacje dla pliku .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.
}
Dason
źródło