หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

ร็อกซิเจน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()

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด