คำอธิบายที่ดีขึ้นเกี่ยวกับเวลาที่จะใช้การนำเข้า / ขึ้นอยู่กับ

คู่มือ " การเขียนส่วนขยาย R " ให้คำแนะนำต่อไปนี้เกี่ยวกับเวลาที่จะใช้การนำเข้าหรือขึ้นอยู่กับ:

กฎทั่วไปคือ

• แพคเกจที่จำเป็นต้องใช้ namespace เท่านั้นในการโหลดแพ็กเกจโดยใช้ไลบรารี่ (pkgname) จะต้องแสดงรายการในฟิลด์ 'Imports' และไม่อยู่ในฟิลด์ 'Depends'
• แพ็กเกจที่ต้องแนบเพื่อโหลดแพ็กเกจสำเร็จโดยใช้ไลบรารี่ (pkgname) จะต้องแสดงรายการในฟิลด์ 'ขึ้นอยู่กับ' เท่านั้น

บางคนสามารถให้ความกระจ่างเกี่ยวกับเรื่องนี้ได้มากกว่านี้หรือไม่? ฉันจะรู้ได้อย่างไรว่าเมื่อใดที่แพ็คเกจของฉันต้องการโหลดเนมสเปซเมื่อเทียบกับเมื่อฉันต้องการแพ็กเกจเท่านั้น ตัวอย่างของทั้งสองคืออะไร ฉันคิดว่าแพคเกจทั่วไปเป็นเพียงชุดของฟังก์ชั่นที่บางครั้งเรียกฟังก์ชั่นในแพ็คเกจอื่น ๆ (ที่มีการทำงานบางส่วนได้รับการเข้ารหัสแล้ว) สถานการณ์นี้เป็น 1 หรือ 2 ข้างต้นหรือไม่

แก้ไข

ฉันเขียนโพสต์บล็อกพร้อมส่วนในหัวข้อเฉพาะนี้ (ค้นหา 'Imports v Depends') ภาพทำให้เข้าใจได้ง่ายขึ้นมาก

"Imports"ปลอดภัยกว่า"Depends"(และทำให้แพ็คเกจที่ใช้เป็น 'พลเมืองที่ดีขึ้น' เมื่อเทียบกับแพ็คเกจอื่น ๆ ที่ใช้งาน"Depends")

"Depends"พยายามสั่งเพื่อให้มั่นใจว่าการทำงานจากแพคเกจอื่นสามารถใช้ได้โดยการติดตั้งแพคเกจอื่น ๆ ไปยังเส้นทางการค้นหาหลัก (เช่นรายการของสภาพแวดล้อมที่ส่งกลับโดยsearch()) อย่างไรก็ตามกลยุทธ์นี้สามารถป้องกันได้หากมีการโหลดแพคเกจอื่นในภายหลังวางฟังก์ชันที่มีชื่อเหมือนกันก่อนหน้านี้บนเส้นทางการค้นหา Chambers ( ใน SoDA ) ใช้ตัวอย่างของฟังก์ชัน"gam"ซึ่งพบได้ทั้งในgamและmgcvแพ็คเกจ หากมีการโหลดแพ็กเกจอื่นสองแพคเกจหนึ่งแพ็กเกจนั้นขึ้นอยู่กับแพ็กเกจที่gamขึ้นอยู่กับmgcvฟังก์ชั่นที่พบโดยการเรียกไปยังgam()จะขึ้นอยู่กับลำดับที่แนบแพ็กเกจทั้งสอง ไม่ดี.

"Imports"สั่งควรจะใช้สำหรับแพคเกจการสนับสนุนใด ๆ ที่มีฟังก์ชั่นจะถูกวางไว้ใน<imports:packageName>(สืบค้นทันทีหลังจาก<namespace:packageName>) แทนในเส้นทางการค้นหาปกติ หากหนึ่งในแพ็กเกจในตัวอย่างด้านบนใช้"Imports"กลไก (ซึ่งจำเป็นต้องมีimportหรือimportFromคำสั่งในNAMESPACEไฟล์) เรื่องต่างๆจะได้รับการปรับปรุงในสองวิธี (1) แพ็คเกจจะได้รับการควบคุมว่าmgcvจะใช้ฟังก์ชันใด (2) โดยการรักษาเส้นทางการค้นหาหลักที่ชัดเจนของวัตถุที่นำเข้ามันจะไม่ได้ทำลายการพึ่งพาแพคเกจอื่น ๆ ในmgcvฟังก์ชั่นอื่น ๆ

นี่คือเหตุผลที่ใช้ namespaces เป็นวิธีที่ดีดังกล่าวว่าทำไมมันจะถูกบังคับใช้ในขณะนี้โดย CRAN และ (โดยเฉพาะอย่างยิ่งใน) ว่าทำไมการใช้จะปลอดภัยกว่าการใช้"Imports""Depends"

แก้ไขเพื่อเพิ่มข้อแม้ที่สำคัญ:

มีข้อยกเว้นอย่างหนึ่งที่พบได้ทั่วไปในคำแนะนำข้างต้น: หากแพ็คเกจของคุณใช้แพ็คเกจAที่"Depends"อยู่ในแพ็คเกจอื่นแพ็คเกจBของคุณอาจจำเป็นต้องแนบมาAพร้อมกับ"Dependsคำสั่ง

เพราะนี่คือฟังก์ชั่นในแพคเกจAที่ถูกเขียนขึ้นด้วยความคาดหวังว่าแพคเกจBและหน้าที่ของตนจะได้รับการติดอยู่กับsearch()เส้นทาง

"Depends"สั่งจะโหลดและแนบแพคเกจAที่จุดแพคเกจAของตัวเอง"Depends"สั่งจะในปฏิกิริยาลูกโซ่, แพคเกจสาเหตุBที่จะโหลดและติดอยู่เช่นกัน ฟังก์ชั่นในแพ็คเกจAจะสามารถค้นหาฟังก์ชั่นในแพ็คเกจBที่พวกเขาพึ่งพาได้

"Imports"สั่งจะโหลด แต่ไม่ได้แนบแพคเกจAและจะไม่โหลดมิได้Bแนบแพคเกจ ( "Imports"หลังจากทั้งหมดคาดว่านักเขียนแพคเกจที่มีการใช้กลไก namespace และแพคเกจที่Aจะใช้"Imports"ในการชี้ไปที่ฟังก์ชั่นใด ๆ ในBการที่จะต้องเข้าถึง.) โทรโดยฟังก์ชั่นของคุณเพื่อฟังก์ชั่นใด ๆ ในแพคเกจAที่พึ่งพาฟังก์ชั่นในแพคเกจBประสงค์ จึงล้มเหลว

โซลูชันที่สองเท่านั้นคือ:

1. ให้แพ็คเกจของคุณแนบแพ็คเกจAโดยใช้"Depends"คำสั่ง
2. ดีกว่าในระยะยาวติดต่อผู้ดูแลบรรจุภัณฑ์Aและขอให้พวกเขาทำงานอย่างระมัดระวังมากขึ้นในการสร้างเนมสเปซของพวกเขา (ในคำพูดของ Martin Morgan ในคำตอบที่เกี่ยวข้องนี้ )

Hadley Wickham ให้คำอธิบายง่ายๆ ( http://r-pkgs.had.co.nz/namespace.html ):

การแสดงรายการแพคเกจอย่างใดอย่างหนึ่งDependsหรือImportsตรวจสอบให้แน่ใจว่ามีการติดตั้งเมื่อจำเป็น ความแตกต่างที่สำคัญคือที่ที่ImportsเพียงโหลดแพคเกจDependsแนบมัน ไม่มีความแตกต่างอื่น ๆ [ ... ]

เว้นแต่จะมีเหตุผลที่ดีมิฉะนั้นคุณควรแพคเกจในรายการไม่ได้Imports Dependsนั่นเป็นเพราะแพคเกจที่ดีนั้นมีอยู่ในตัวเองและลดการเปลี่ยนแปลงสภาพแวดล้อมโลกให้น้อยที่สุด (รวมถึงเส้นทางการค้นหา) ข้อยกเว้นเพียงอย่างเดียวคือถ้าแพ็คเกจของคุณถูกออกแบบมาเพื่อใช้ร่วมกับแพ็คเกจอื่น ตัวอย่างเช่นแพ็คเกจอะนาล็อกจะถูกสร้างขึ้นที่ด้านบนของวีแก้น มันไม่ได้มีประโยชน์โดยไม่ต้องมังสวิรัติจึงมีอาหารมังสวิรัติในแทนDepends Importsในทำนองเดียวกัน ggplot2 ควรขึ้นอยู่กับเครื่องชั่งมากกว่าการนำเข้า

Chambers ใน SfDA บอกว่าจะใช้ 'Imports' เมื่อแพ็คเกจนี้ใช้กลไก 'namespace' และเนื่องจากแพ็คเกจทั้งหมดจำเป็นต้องมีในตอนนี้ดังนั้นคำตอบจึงอาจใช้ 'Imports' เสมอ ในแพคเกจที่ผ่านมาสามารถโหลดได้โดยไม่ต้องมี namespaces จริงและในกรณีที่คุณจะต้องใช้ขึ้นอยู่กับ

นี่เป็นคำถามง่าย ๆ ที่จะช่วยคุณตัดสินใจว่าจะใช้อะไร:

แพ็คเกจของคุณต้องการให้ผู้ใช้ปลายทางเข้าถึงฟังก์ชั่นของแพ็คเกจอื่นได้โดยตรงหรือไม่?

• NO -> การนำเข้า (คำตอบที่พบบ่อยที่สุด)
• ใช่ -> ขึ้นอยู่กับ

ครั้งเดียวที่คุณควรใช้ 'ขึ้นอยู่กับ' คือเมื่อแพ็คเกจของคุณเป็นส่วนเสริมหรือเป็นคู่หูในแพ็คเกจอื่นซึ่งผู้ใช้ของคุณจะใช้ฟังก์ชันจากทั้งแพ็คเกจของคุณและแพคเกจ 'ขึ้นอยู่กับ' ในรหัสของพวกเขา หากผู้ใช้ปลายทางของคุณจะเชื่อมต่อกับฟังก์ชั่นของคุณเท่านั้นและแพ็คเกจอื่น ๆ จะทำงานได้เพียงเบื้องหลังเท่านั้นให้ใช้ 'Imports' แทน

ข้อแม้นี้ก็คือว่าถ้าคุณเพิ่มแพคเกจจะ 'นำเข้า' ในขณะที่คุณมักจะควรโค้ดของคุณจะต้องดูการทำงานจากแพคเกจที่ใช้ไวยากรณ์ namespace เต็มรูปแบบเช่นแทนเพียงdplyr::mutate() mutate()มันทำให้รหัสเล็ก ๆ น้อย ๆ ที่จะอ่าน แต่มันเป็นราคาขนาดเล็กที่จะจ่ายสำหรับสุขอนามัยแพคเกจที่ดีขึ้น