2011-03-11 3 views
91

Roxygen의 작동 방식은 첫 번째 라인이 \title이고 그 외 모든 것이 \details이며 그 다음에 어떤 것이 든 @foo 지시어가 처리합니다. 그러나 R 문서는 그보다 풍부합니다. .Rd 파일에 "\section{Llamas}{Are they ungulates?}"을 가질 수 있습니다.roxygen docs의 임의 섹션

하지만 Roxygen이 \ 세부 사항에서 모두 포장하는 것 이외의 것을 할 수는 없습니다. 내가 놓친 게 있니?

\section 앞에 일치하지 않는 }을 붙여야하는 해킹 솔루션이 있습니다. 그런 다음 \details 섹션을 종료합니다. roxygen이 닫히는 것을 생각할 때 \details을 생각하기 때문에 나는 그 때 엔딩을 }에 두지 않아야한다. Eeeeeurrrrrrrrrghgh.

+2

우수 질문을 제기주는 예

#' 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") } 

입니다. 나는 이것이 현재로서는 할 수 없다는 것이 맞다고 생각합니다. 그러나 해들리 위컴 (Hadley Wickham)은 최근에 어떻게 미래의 수소 생성에 열쇠를 쥐고 있는지에 대해 언급하면서 가까운 장래에 놀라운 일이 나타날 것으로 기대하고 있습니다. – Andrie

+4

당신이 얻고 싶은 깊이에 따라 해들리가하고있는 일을 도와 줄 수 있습니다. 그의 작품이 놀랍다는 것을 알지만 결국, '벨, 그는 그냥 zis guy 일 뿐이야?'. Hadley가 github https://github.com/hadley/roxygen에 게시 한 코드를 정독하여 그에게 전자 메일을 보내고 요청할 수도 있습니다. – PaulHurleyuk

+1

물론입니다. 해들리도 여기에서 봤어. 그래서 그는 알고 있을지도 몰라. 처음에는 "@section Llamas"지시문이나 그와 비슷한 내용을 문서에서 놓친다 고 생각했습니다. – Spacedman

답변

16

이 지원이 추가되었습니다 (적어도 roxygen2에서). @section Llamas:을 추가해야합니다. 그 다음에 새로운 지시문이 충족 될 때까지 Llamas 섹션에 추가하면됩니다. 여기서하여 .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. 
} 
+3

Llamas rock !!!! – BrodieG