roxygen2에 항목 목록을 추가하는 적절한 구문은 무엇입니까 (예 : @details 섹션)? 라텍스 목록 환경을 만들 수 있습니까?Roxygen에서 문서화 할 때 : @details에 항목 별 목록을 만들려면 어떻게해야합니까?
그 줄 바꿈이 단순히 무시하는 것 즉
#' @details text describing parameter inputs in more detail
#'
#' parameter 1: stuff
#'
#' parameter 2: stuff
감사합니다!
다음은 문제 공식화 후의 roxygen2 예제입니다.
##'
##' @details text describing parameter inputs in more detail.
##' \itemize{
##' \item{"parameter 1"}{Stuff}
##' \item{"parameter 2"}{Stuff}
##' }
##'
이렇게하면 세부 정보 섹션에 itemize를 사용할 수 있습니다. @param 섹션에서도 사용할 수 있습니다.
희망이 도움이됩니다.
발견 한 문서를 가르쳐 주시겠습니까? Roxygen의 라텍스 기능에 대한 구문을 이해하는 데 어려움을 겪고 있습니다. –
@JeffAllen "Writing R Extensions"매뉴얼의 http://cran.r-project.org/doc/manuals/R-exts.html#Lists-and-tables 섹션을 살펴본 후 Roxygen에서 시도해 보았습니다. 그것은 나를 위해 잘 작동합니다. 특정 문제가 있습니까? –
@JeffAllen 이것은 단지 LaTeX 스타일 인 목록의 표준 R doc (.Rd) 스타일 일뿐입니다. roxygen과 .Rd 모두에 문제가 있다는 것은 tex에서 작동하는 것이 .Rd에서 작동하고, .Rd에서 작동하는 것이 roxygen에서 작동 할 때를 예측하기가 어려울 수 있다는 것입니다. – cboettig
roxygen2 6.0.0부터 R 문서에서 직접 markdown을 사용할 수 있습니다.
#' @details text describing parameter inputs in more detail.
#' * parameter 1 stuff
#' * parameter 2 stuff
#' @md
@md 태그를 추가 할 설명이 어느
Roxygen: list(markdown = TRUE)을 포함 사용하십시오.
문서 : Gäbor Csardi의 [Markdown의 R 문서 작성] (https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html#lists) "목록 앞에 빈 줄을 남겨 두지 않아도된다는 점에 유의하십시오. 이것은 일부 마킹 다운 파서와 다릅니다." –
R 확장 매뉴얼 작업에서와 같이'\ describe {}','\ itemize {}'를합니까? –
@Ben 예 그들 do – hadley