Khi ghi lại trong Roxygen: Làm cách nào để tạo danh sách được phân mục trong @details?

Question

Cú pháp thích hợp để thêm danh sách được phân loại vào roxygen2 là gì, ví dụ, trong phần @details? Tôi có thể tạo một môi trường danh sách latex không?

Dường như ngắt dòng chỉ đơn giản là bỏ qua, ví dụ:

#' @details text describing parameter inputs in more detail 
#' 
#' parameter 1: stuff 
#' 
#' parameter 2: stuff 

cảm ơn!

Answer 1

Dưới đây là ví dụ về roxygen2 sau công thức vấn đề của bạn.

##' 
##' @details text describing parameter inputs in more detail. 
##' \itemize{ 
##' \item{"parameter 1"}{Stuff} 
##' \item{"parameter 2"}{Stuff} 
##' } 
##' 

Điều này sẽ cho phép bạn sử dụng mục cụ thể trong phần chi tiết. Bạn cũng có thể sử dụng nó trong phần @param.

Hy vọng điều này sẽ hữu ích.

Answer 2

Vì roxygen2 6.0.0 bạn có thể sử dụng đánh dấu trực tiếp trong tài liệu R của mình.

#' @details text describing parameter inputs in more detail. 
#' * parameter 1 stuff 
#' * parameter 2 stuff 
#' @md 

Để sử dụng một trong hai bao gồm Roxygen: list(markdown = TRUE) trong mô tả của bạn để biến markdown trên cho toàn bộ gói hoặc thêm thẻ @md vào một tập tin duy nhất.