program tip

roxygen 문서의 임의 섹션

radiobox 2020. 8. 29. 09:46
반응형

roxygen 문서의 임의 섹션


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

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

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


이 지원이 추가되었습니다 (적어도 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.
}

참고 URL : https://stackoverflow.com/questions/5275578/arbitrary-sections-in-roxygen-docs

반응형