roxygen 문서의 임의 섹션


93

Roxygen 이 작동하는 것처럼 보이는 방식 은 첫 번째 줄이 \title이고 나머지는 모두 \details, 그리고 모든 @foo지시문이 이러한 작업을 처리한다는 것입니다. 그러나 R 문서는 그보다 더 풍부합니다. 내가 할 수 "\section{Llamas}{Are they ungulates?}".Rd 파일에.

그러나 나는 Roxygen이 모든 것을 \ details로 감싸는 것 외에는 아무것도 할 수 없습니다. 내가 뭔가를 놓치고 있습니까?

나는 해키 솔루션을 가지고 있는데, 그것은 }\section. 그러면 \details섹션 이 끝납니다 . 나는 다음 종료 두지해야 }roxygen 스틱 생각 하나 그것을 닫기 때문에,에서를 \details. Eeeeeurrrrrrrrgh.


2
훌륭한 질문입니다. 지금은이 일을 할 수 없다고 생각합니다. 그러나 Hadley Wickham은 최근 그가 어떻게 미래의 록시 젠 개발의 열쇠를 쥐고 있는지에 대해 언급 했으므로 가까운 장래에 놀라운 것이 나타날 수 있기를 바랍니다.
Andrie 2011 년

4
얼마나 깊이 알고 싶은지에 따라 Hadley가하는 일을 도와 주겠다고 제안 할 수 있습니다. 그의 작품이 굉장하다는 건 알지만, 결국 'Vell, 그는 그냥 zis 녀석이야. 당신은 해들리는 github의의에 게시 한 코드를 정독 할 수 있습니다 github.com/hadley/roxygen ... 그를 어쩌면 그에게 이메일을 보내 물어
PaulHurleyuk

1
확실한. 나도 여기에서 해들리를 봤기 때문에 그가 알고 있을지도 모른다. 처음에는 문서에서 "@section Llamas"지시문 또는 이와 유사한 내용을 놓쳤다 고 생각했습니다.
Spacedman 2011 년

6
나는 라마를 좋아한다. 그게 다입니다.
JD Long

3
@sectionroxygen2 에서 태그를 참조하십시오
hadley 2011

답변:


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.