Произвольные разделы в документах roxygen


93

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

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

У меня есть хакерское решение, которое заключается в том, чтобы поставить }перед моим \section. На этом \detailsраздел заканчивается . Тогда я не должен вставлять концовку }, потому что roxygen придерживает одну, думая, что закрывает \details. Eeeeeurrrrrrrrgh.


2
Отличный вопрос. Я подозреваю, что вы правы, что в настоящий момент это невозможно. Но Хэдли Уикхэм недавно упомянул, что он является ключом к будущему развитию roxygen, поэтому я надеюсь, что в ближайшем будущем появится что-то удивительное.
Андри,

4
В зависимости от того, насколько глубоко вы хотите получить информацию, вы можете предложить помощь Хэдли в том, что он делает. Я знаю, что его работа потрясающая, но, в конце концов, «Велл, он просто парень, понимаете?». Возможно, вы захотите просмотреть код, который Хэдли опубликовал на github github.com/hadley/roxygen, и, возможно, отправить ему электронное письмо и спросить его ...
Пол Херлейк

1
Конечно. Я тоже видел здесь Хэдли, так что он может быть в курсе. Сначала я подумал, что пропустил что-то в документации, например директиву @section Llamas или что-то подобное.
Spacedman

6
Я действительно люблю лам. Это все.
JD Long

3
См. @sectionТег в roxygen2
Хэдли

Ответы:


22

Эта поддержка была добавлена ​​(по крайней мере, в roxygen2). Вам просто нужно добавить, @section Llamas:и тогда все, что после этого, пока не будет достигнута новая директива, будет в разделе 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

\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.
}
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.