roxygenドキュメントの任意のセクション


93

Roxygenが機能しているように見える方法は、最初の行がであり\title、他のすべてがにあり\details、その後@fooディレクティブがそれらを処理するというものです。しかし、Rのドキュメントはそれよりも豊富です。"\section{Llamas}{Are they ungulates?}".Rdファイルに含めることができます。

しかし、Roxygenにすべてを\ detailsでラップする以外のことはできません。何か不足していますか?

私は、}私の前に他の追随を許さないハックソリューションを持ってい\sectionます。これで\detailsセクションが終了します。}roxygenがを閉じることを考えているので、エンディングを入れないで\detailsください。Eeeeeurrrrrrrrgh。


2
すばらしい質問です。現時点ではこれができないのは正しいと思います。しかしハドリー・ウィッカムは最近、彼がどのようにロキシゲンの将来の開発の鍵を握っているのかを述べたので、私は近い将来に驚くべきものが現れることを期待しています。
Andrie

4
どれだけ深く知りたいかに応じて、ハドリーが彼のやっていることを手伝うことを申し出るかもしれません。彼の作品は素晴らしいと思いますが、結局のところ、「まあ、彼は単なるzisの男ですよね?」Hadleyがgithub github.com/hadley/roxygenで公開したコードを熟読し、おそらく彼にメールを送って質問してもよいでしょう
PaulHurleyuk

1
承知しました。私もここでハドリーを見たので、彼は気づいているかもしれません。最初は、ドキュメントで "@section Llamas"ディレクティブなどのようなものを見逃していると思いました。
Spacedman、2011年

6
私は確かにラマが好きです。以上です。
JD Long

3
@sectionroxygen2 のタグを参照してください
ハドリー'19

回答:


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.
}
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.