जब Roxygen में दस्तावेज़ांकन: मैं @details में एक आइटमीकृत सूची कैसे बना सकता हूं?

Question

उदाहरण के लिए, @details अनुभाग में roxygen2 में एक आइटमीकृत सूची जोड़ने के लिए उपयुक्त वाक्यविन्यास क्या है? क्या मैं लेटेक्स सूची वातावरण बना सकता हूं?

ऐसा लगता है कि पंक्ति विराम बस अनदेखी कर रहे हैं अर्थात

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

धन्यवाद!

Answer 1

यहां आपकी समस्या फॉर्मूलेशन के बाद एक roxygen2 उदाहरण है।

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

इससे आपको विवरण अनुभाग में आइटम का उपयोग करने की अनुमति मिल जाएगी। आप इसे @param सेक्शन में भी इस्तेमाल कर सकते हैं।

उम्मीद है कि इससे मदद मिलती है।

Answer 2

चूंकि roxygen2 6.0.0 आप सीधे अपने आर दस्तावेज़ में मार्कडाउन का उपयोग कर सकते हैं।

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

पूरे पैकेज के लिए पर markdown देते हैं या एक एकल फाइल करने के लिए @md टैग को जोड़ने के लिए अपने विवरण में यह या तो शामिल Roxygen: list(markdown = TRUE) का उपयोग करें।