Roxygen文档中的任意部分


93

Roxygen的工作方式似乎是第一行是\title,其他所有内容都在中\details,然后任何@foo指令都可以处理这些内容。但是R文档比这更丰富。我可以"\section{Llamas}{Are they ungulates?}"在.Rd文件中使用。

但是我不能让Roxygen除了将所有内容都包装在\ details中之外,无能为力。我想念什么吗?

我有一个骇人听闻的解决方案,那就是把无与伦比的东西}摆在我面前\section。然后,该\details部分结束。然后,我不必结束}任何事情,因为roxygen一直以为它关闭了它\details。Eeeeeurrrrrrrrgh。


2
很好的问题。我怀疑您是正确的,目前无法执行此操作。但是哈德利·威克汉姆(Hadley Wickham)最近提到,他如何把握未来制氧技术的关键,因此我希望不久的将来会出现一些惊人的事情。
Andrie

4
根据您想要获得的深度,您可能会提供帮助Hadley所做的事情。我知道他的工作很棒,但毕竟,“好吧,他只是个小伙子,你知道吗?”。您可能想细读Hadley在github github.com/hadley/roxygen上发布的代码,也许给他发送电子邮件并问他...
PaulHurleyuk 2011年

1
当然。我也看到过哈德利,所以他可能知道。起初,我以为我会错过文档中的某些内容,例如“ @section Llamas”指令或类似内容。
Spacedman 2011年

6
我肯定喜欢骆驼。就这些。
JD龙

3
参见@sectionroxygen2中的标签
hadley 2011年

Answers:


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.
}
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.