คำถามติดแท็ก roxygen2

สำหรับการทำเอกสารคลาสที่มี roxygen (2) การระบุหัวเรื่องและคำอธิบาย / รายละเอียดดูเหมือนจะเหมือนกับฟังก์ชันวิธีการข้อมูลและอื่น ๆ อย่างไรก็ตามสล็อตและการสืบทอดเป็นสัตว์ประเภทของตัวเอง แนวปฏิบัติที่ดีที่สุด - ปัจจุบันหรือที่วางแผนไว้สำหรับการบันทึกคลาส S4 ใน roxygen2 คืออะไร ขยันเนื่องจาก: ฉันพบ@slotแท็กในคำอธิบายก่อนหน้าของ roxygen การโพสต์รายชื่อผู้รับจดหมาย R-forge ปี 2008 ดูเหมือนจะบ่งบอกว่านี่เป็นสิ่งที่ตายแล้วและไม่มีการสนับสนุน@slotใน roxygen: นี่เป็นความจริงของ roxygen2 หรือไม่ โพสต์ที่กล่าวถึงก่อนหน้านี้แนะนำให้ผู้ใช้ควรทำรายการแยกรายการของตนเองด้วยมาร์กอัป LaTeX เช่นคลาส S4 ใหม่ที่ขยาย"character"คลาสจะมีการเข้ารหัสและจัดทำเอกสารดังนี้: #' The title for my S4 class that extends \code{"character"} class. #' #' Some details about this class …

306 class  r  s4  slot  roxygen2 

ตอนนี้ฉันกำลังเขียนฟังก์ชัน geocodingซึ่งอาศัยการมี Bing Maps Key เห็นได้ชัดว่าฉันไม่อยากเผยแพร่ของฉันและตัวอย่างก็ล้มเหลวหากไม่มี ฉันจะรวมตัวอย่างเพื่อให้ผู้ใช้เรียกใช้ด้วยตนเอง แต่ไม่ได้ดำเนินการในระหว่างนั้นได้R CMD checkอย่างไร

96 r  roxygen2 

ปิด . คำถามนี้เป็นคำถามความคิดเห็นตาม ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบพร้อมข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ ฉันมีRแพ็คเกจที่ใช้roxygen2. มีCรหัสอยู่/srcและฉันเพิ่งเริ่มทำงานกับ Doxygen มีวิธีใดบ้างในการรวมเอกสารหรือรวมการคอมไพล์กับ roxygen2? "แนวทางปฏิบัติที่ดีที่สุด" สำหรับวางCเอกสารโค้ดไว้ที่ใด Googling สำหรับ roxygen2 และ doxygen ส่วนใหญ่นำไปสู่roxygen คล้ายกับผลลัพธ์ของdoxygen ฉันพบสองสามแพ็คเกจกับ Doxyfiles แต่ไม่มีองค์กรที่สอดคล้องกัน ตัวอย่างเช่น lme4 มีinst/doc/Doxyfileเอาต์พุตไปยังโฟลเดอร์ที่เรียกว่าdoxygenภายนอกlme4ไดเร็กทอรีต้นทาง นอกจากนี้ยังมี Doxyfile ในไดเร็กทอรีรากของ Matrix (แต่ในรีลีสก่อนหน้านี้อยู่ในinstเอกสารนี้จะถูกส่งออกนอกไดเร็กทอรีแพ็กเกจด้วย มีเหตุผลที่จะไม่รวมถึงการใด ๆCเอกสารภายในแพคเกจหรือทำไม Doxygen ใช้เพื่อบ่อยภายในแพคเกจ R แม้จะมีการใช้อย่างแพร่หลายของC? อัปเดต:ดูคำขอคุณลักษณะ roxygen2ที่เกี่ยวข้อง

91 c  r  documentation  doxygen  roxygen2