Краще пояснення, коли використовувати імпорт / залежно

Посібник " Написання розширень R " надає наступні вказівки щодо використання імпорту або залежностей:

Загальні правила є

• Пакети, простору імен яких потрібно лише для завантаження пакету за допомогою бібліотеки (pkgname), повинні бути вказані в полі "Імпорт", а не в полі "Залежить".
• Пакети, які потрібно приєднати для успішного завантаження пакета за допомогою бібліотеки (pkgname), повинні бути вказані лише у полі "Залежить".

Чи може хтось надати трохи більше ясності щодо цього? Як дізнатися, коли мій пакет потребує завантаження лише просторів імен порівняно з тим, коли мені потрібен пакет, який потрібно додавати? Якими є приклади обох? Я думаю, що типовий пакет - це лише сукупність функцій, які іноді викликають функції в інших пакетах (де деякі роботи вже зашифровані). Це сценарій 1 або 2 вище?

Редагувати

Я написав допис у блозі з розділом на цю конкретну тему (пошук "Імпорт проти залежних"). Наочні зображення значно полегшують розуміння.

"Imports"є безпечнішим, ніж "Depends"(а також робить пакет, використовуючи його "кращим громадянином" стосовно інших пакетів, які використовують"Depends" ).

А "Depends"директива спроба гарантувати , що функція з іншого пакета можна, прикріпивши інший пакет до основного шляху пошуку (тобто список середовищ , повернутих search()). Ця стратегія, однак, може бути зірвана, якщо інший пакет, завантажений пізніше, розміщує ідентично названу функцію раніше на шляху пошуку. Чемберс ( в SoDA ) використовує приклад функції "gam", яка знаходиться в обох gamі mgcvпакетах. Якщо було завантажено два інших пакети, один із яких залежно від gamодного, а один залежно від цього mgcv, функція, знайдена дзвінками gam(), залежатиме від порядку, в якому вони були приєднані. Не добре.

"Imports"Директива повинна бути використана для будь-якого підтримує пакета, функції якого повинні бути поміщені в <imports:packageName>(пошук відразу після <namespace:packageName>), а НЕ на регулярній шляху пошуку. Якщо будь-який із пакунків у наведеному вище прикладі використовував "Imports"механізм (який також вимагає importабо importFromдирективи у NAMESPACEфайлі), питання будуть покращені двома способами. (1) Пакет сам отримає контроль над тим, яка mgcvфункція використовується. (2) Зберігаючи основний шлях пошуку від імпортованих об'єктів, він навіть потенційно не може порушити залежність іншого пакета від іншої mgcvфункції.

Ось чому використання просторів імен є такою хорошою практикою, чому це зараз застосовується CRAN, і (зокрема), чому використовувати "Imports"безпечніше, ніж використовувати "Depends".

Відредаговано, щоб додати важливе застереження:

Існує одна , до жаль , загальне виключення до порад вище: якщо ваш пакет залежить від пакета , Aякий сам "Depends"на інший пакет B, пакет, швидше за все , буде потрібно докласти Aз "Dependsдирективою.

Це тому, що функції в пакеті Aбули написані з очікуванням, що пакет Bі його функції будуть приєднані до search()шляху .

"Depends"Директива буде завантажувати і прикласти пакет A, в якому точки пакету A«s власна "Depends"буде, в ланцюгової реакції, тому що пакет директива Bповинна бути завантажений і додається також. Функції в пакеті Aпотім зможуть знайти функції в пакеті, Bна які вони покладаються.

"Imports"Директива буде завантажуватися , але НЕ докласти пакет Aі буде ні вантаж , ні приєднувати пакет B. ( В "Imports"кінці кінців, очікує , що пакет автори використовують механізм просторів імен, і цей пакет Aбуде використовувати "Imports"для точки до будь-якої функції , в Bтому , що він потрібен доступ к.) Викликам ваших функцій на будь-які функції в пакеті , Aякі засновані на функціях пакета Bволі отже, не вдається.

Єдине два рішення:

1. Попросіть ваш пакет додавати пакунок, Aвикористовуючи "Depends"директиву.
2. Краще, зрештою, зверніться до сервісного пакета Aі попросіть їх зробити більш ретельну роботу зі створення свого простору імен (словами Мартіна Моргана у цій відповіді ).

Хедлі Вікхем дає просте пояснення ( http://r-pkgs.had.co.nz/namespace.html ):

Перерахування пакету в DependsабоImports гарантує його встановлення за потреби. Основна відмінність полягає в тому, що там, де Importsпросто завантажується пакет, Dependsприкріплюється його. Інших відмінностей немає. [...]

Якщо немає поважних причин інакше, ви завжди повинні перераховувати пакети в Importsне Depends. Це тому, що хороший пакет є самостійним і мінімізує зміни в глобальному середовищі (включаючи шлях пошуку). Єдиний виняток - якщо ваш пакунок призначений для використання разом з іншим пакетом. Наприклад, аналоговий пакет будується поверх веганського. Це не корисно без веганства, тому він має веганську Dependsзамість Imports. Аналогічно, ggplot2 дійсно повинен залежати від масштабів, а не імпортувати їх.

Chambers в SfDA говорить, що використовувати "Імпорт", коли цей пакет використовує механізм "простору імен", і оскільки всі пакети тепер повинні мати їх, то тепер у відповіді завжди можна використовувати "Імпорт". У минулому пакунки могли бути завантажені без фактичного простору імен, і в цьому випадку вам потрібно було б використовувати залежно.

Ось просте запитання, яке допоможе вам вирішити, який використовувати:

Чи вимагає ваш пакет, щоб кінцевий користувач мав прямий доступ до функцій іншого пакету?

• НІ -> Імпорт (найчастіша відповідь)
• ТАК -> Залежить

Єдиний раз, коли ви повинні використовувати "Залежить", це коли ваш пакет є додатком або супутником до іншого пакету, де ваш кінцевий користувач буде використовувати функції як вашого пакета, так і пакета "Залежить" у своєму коді. Якщо ваш кінцевий користувач буде взаємодіяти лише з вашими функціями, а інший пакет буде виконувати роботу лише за кадром, тоді замість цього використовуйте "Імпорт".

Застереження в цьому полягає в тому, що якщо ви додасте пакет до "Імпорту", як зазвичай, ваш код повинен буде посилатися на функції цього пакету, використовуючи повний синтаксис простору імен, наприклад dplyr::mutate(), замість просто mutate(). Це робить код трохи незграбним для читання, але це плата за кращу гігієну упаковки.