Произвольные разделы в roxygen docs

путь Roxygen кажется, что первая строка-это title, все остальное-в details, а затем @foo директивы обрабатывают эти вещи. Но R документация богаче, чем это. Я могу иметь "section{Llamas}{Are they ungulates?}" in .Файлы удаленных рабочих столов.

но я не могу заставить Roxygen делать что-либо, кроме как обернуть все это в детали. Я что-то упустил?

у меня есть хакерское решение, которое заключается в том, чтобы придерживаться непревзойденного } перед моими section. Это тогда заканчивается . Я тогда не должен ставить окончание } В, потому что roxygen втыкает один в мышление его закрытия details. Эээээ ...

1 93
javascript roxygen2

1 ответ:

эта поддержка была добавлена (по крайней мере в roxygen2). Вам просто нужно добавить @section 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 file

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