Довільні розділи в документах про роксиген

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

Але я не можу змусити Роксиген нічого робити, крім загортання всього в \ деталі. Я щось пропускаю?

У мене є хитке рішення, яке полягає в тому, щоб дотримуватися неперевершеного }перед моїм \section. На цьому закінчується \detailsрозділ. Тоді я не повинен ставити закінчення }, тому що роксиген дотримується одного, думаючи про його закриття \details. Eeeeeurrrrrrrrgh.

r roxygen

— Spacedman
джерело

Відмінне запитання. Я підозрюю, що ви праві, що наразі цього неможливо зробити. Але Хедлі Вікхем нещодавно згадав, що він є ключем до подальшого розвитку роксигену, тому я сподіваюся, що щось дивовижне з'явиться найближчим часом.

— Андрі

Залежно від того, наскільки глибоко ви хочете отримати, ви можете запропонувати допомогти Хедлі у тому, що він робить. Я знаю, що його робота дивовижна, але зрештою, "Велл, він просто зіс, ти знаєш?". Ви можете ознайомитись з кодом, який Хадлі опублікував на веб-сайті github github.com/hadley/roxygen і, можливо, надішлете йому електронний лист і запитаєте його ...

— Павло Хурлюк

Звичайно. Я бачив тут і Хедлі, тому він, можливо, знає. Спочатку я думав, що пропустив щось у документах, як-от директива "@section Llamas" чи подібне.

— Спайдермен

Я впевнено люблю лами. Це все.

— JD Long

Дивіться @sectionтег у roxygen2

— hadley

Ця підтримка була додана (принаймні, у 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.
}

— Десон
джерело