الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

روكسجين2

فرضية roxygen2 بسيطة: قم بوصف وظائفك في التعليقات بجانب تعريفاتها وسيقوم roxygen2 بمعالجة كود المصدر والتعليقات الخاصة بك لإنشاء ملفات .Rd تلقائيًا في man/ و NAMESPACE ، وإذا لزم الأمر، في حقل Collate في DESCRIPTION .

تثبيت 

 # Install roxygen2 from CRAN
install.packages( " roxygen2 " )

# Or the development version from GitHub:
# install.packages("pak")
pak :: pak( " r-lib/roxygen2 " )

الاستخدام

فرضية roxygen2 بسيطة: قم بوصف وظائفك في التعليقات بجوار تعريفاتها وسيقوم roxygen2 بمعالجة كود المصدر والتعليقات الخاصة بك لإنتاج ملفات Rd في الدليل man/ . فيما يلي مثال بسيط من حزمة stringr: 

 # ' The length of a string
# '
# ' Technically this returns the number of "code points", in a string. One
# ' code point usually corresponds to one character, but not always. For example,
# ' an u with a umlaut might be represented as a single character or as the
# ' combination a u and an umlaut.
# '
# ' @inheritParams str_detect
# ' @return A numeric vector giving number of characters (code points) in each
# '    element of the character vector. Missing string have missing length.
# ' @seealso [stringi::stri_length()] which this function wraps.
# ' @export
# ' @examples
# ' str_length(letters)
# ' str_length(NA)
# ' str_length(factor("abc"))
# ' str_length(c("i", "like", "programming", NA))
str_length <- function ( string ) {
}

عندما تقوم roxygenise() (أو devtools::document() ) سيتم تحويل هذه التعليقات تلقائيًا إلى الحزمة الخاصة بك إلى .Rd الذي يستخدمه R لإنشاء الوثائق التي تراها عندما تكتب ?str_length .

يتعلم أكثر

للبدء، اقرأ أولاً vignette("roxygen2") . ثم اقرأ المزيد حول مكون الحزمة المحدد الذي تريد إنشاءه:

  • ابدأ بـ vignette("rd") لتتعرف على كيفية توثيق وظائفك باستخدام roxygen2.

  • تناقش vignette("rd-other") كيفية توثيق أشياء أخرى مثل مجموعات البيانات، والحزمة نفسها، والأجزاء المختلفة التي تستخدمها أنظمة OOP الخاصة بـ R.

  • vignette("rd-formatting") تعطي تفاصيل دعم rmarkdown لـ roxygen2.

  • توضح vignette("reuse") الأدوات المتاحة لإعادة استخدام الوثائق في أماكن متعددة.

  • تصف vignette("namespace") كيفية إنشاء ملف NAMESPACE ، وكيفية عمل مساحة الاسم في R، وكيف يمكنك استخدام roxygen2 لتكون محددًا بشأن ما تحتاجه الحزمة الخاصة بك ومستلزماتها.

  • بالنسبة لحقل Collate في DESCRIPTION ، راجع ?update_collate() .

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل