r - tool - كلمات دلالية يوتيوب




عند التوثيق في Roxygen: كيف أقوم بإنشاء قائمة مفصلة في تفاصيل @؟ (2)

فيما يلي مثال roxygen2 يتبع صياغة مشكلتك.

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

هذا سيسمح لك باستخدام البند في قسم التفاصيل. يمكنك أيضًا استخدامه في أقسامparam.

أتمنى أن يساعدك هذا.

ما هو بناء الجملة المناسب لإضافة قائمة مفصلة إلى roxygen2 ، على سبيل المثال ، في قسم التفاصيل @؟ هل يمكنني إنشاء بيئة قائمة اللاتكس؟

يبدو أن فواصل الأسطر يتم تجاهلها ببساطة ، أي

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

شكر!


منذ roxygen2 6.0.0 يمكنك استخدام تخفيض السعر مباشرة في وثائق R.

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

لاستخدام هذا إما تضمين Roxygen: list(markdown = TRUE) في الوصف الخاص بك لتشغيل تخفيض السعر للحزمة بالكامل أو إضافة علامة @md إلى ملف واحد.





roxygen