İthalat / Bağımlılıkların ne zaman kullanılacağına dair daha iyi açıklama

" R Uzantılarını Yazma " kılavuzu, İçe Aktarmalar veya Bağımlıların ne zaman kullanılacağına ilişkin aşağıdaki rehberliği sağlar:

Genel kurallar

• Kitaplığı kullanarak paketi yüklemek için yalnızca ad alanı gereken paketler (pkgname), 'Bağımlılar' alanında değil 'İçe Aktarmalar' alanında listelenmelidir.
• Paketi kullanarak kitaplığı (pkgname) başarıyla yüklemek için eklenmesi gereken paketler, yalnızca 'Bağımlılar' alanında listelenmelidir.

Birisi bu konuda biraz daha netlik sağlayabilir mi? Paketimin yalnızca ad alanlarının yüklenmesine ihtiyacı olduğunda ve eklenmesi gereken bir pakete ihtiyacım olduğunda nasıl anlarım? Her ikisinin örnekleri nelerdir? Bence tipik paket, bazen başka paketlerdeki işlevleri çağıran bir işlevler koleksiyonudur (burada bazı çalışmalar zaten kodlanmıştır). Yukarıdaki senaryo 1 veya 2 mi?

Düzenle

Bu belirli konuyla ilgili bir bölüm içeren bir blog yazısı yazdım ('İthalat ve Bağlıdır' için arama yapın). Görseller anlaşılmasını çok kolaylaştırıyor.

"Imports"olduğundan daha güvenlidir "Depends"(ve aynı zamanda onu kullanan bir paketi, kullanılan diğer paketlere göre 'daha iyi bir vatandaş' yapar "Depends").

Bir "Depends"yönerge, diğer paketi ana arama yoluna (yani tarafından döndürülen ortamların listesi search()) ekleyerek başka bir paketten bir işlevin kullanılabilir olmasını sağlamaya çalışır . Bununla birlikte, daha sonra yüklenen başka bir paket, arama yoluna daha önce aynı şekilde adlandırılmış bir işlevi yerleştirirse, bu strateji engellenebilir. (Chambers soda ) fonksiyonunun örneğini kullanarak, "gam"hem de bulunur, gamve mgcvpaketler. gamBiri bağlı, diğeri bağlı olmak üzere iki paket daha yüklenmişse, mgcvçağrılar tarafından bulunan işlev, gam()bu iki paketin eklendiği sıraya bağlı olacaktır. İyi değil.

Bir "Imports"yönerge , normal arama yolu yerine işlevleri yerleştirilecek <imports:packageName>(hemen sonra aranacak <namespace:packageName>) herhangi bir destekleyici paket için kullanılmalıdır . Yukarıdaki örnekte yer alan paketlerden biri "Imports"mekanizmayı kullanıyorsa (bu aynı zamanda dosyada gerekli importveya importFromdirektifleri gerektirir NAMESPACE), meseleler iki şekilde iyileştirilebilir. (1) Paket, hangi mgcvişlevin kullanılacağı üzerinde kontrol sahibi olacaktır . (2) Ana arama yolunu içe aktarılan nesnelerden uzak tutmak, diğer paketin diğer mgcvişleve olan bağımlılığını potansiyel olarak bozmayacaktır .

Ad alanlarının kullanılmasının bu kadar iyi bir uygulama olmasının nedeni budur, neden şimdi CRAN tarafından uygulanmaktadır ve (özellikle) kullanımın kullanmaktan "Imports"daha güvenli olmasının nedeni budur "Depends".

Önemli bir uyarı eklemek için düzenlendi:

Orada bir yukarıdaki tavsiye maalesef yaygın istisna: paketiniz bir paket dayanıyorsa Akendisi "Depends"başka paket üzerinde B, paketiniz olasılıkla takmak gerekir Abir ile "Dependsdirektifi.

Bunun nedeni , paketteki işlevlerin A, paket Bve işlevlerinin search()yola ekleneceği beklentisiyle yazılmış olmasıdır .

Bir "Depends"yönerge paketi yükleyecek ve ekleyecektir A, bu noktada paketin Akendi "Depends"yönergesi bir zincirleme reaksiyonda paketin Byüklenmesine ve eklenmesine neden olacaktır. Paketteki işlevler Adaha sonra Bbağlı oldukları paketteki işlevleri bulabilecekler .

Bir "Imports"yönerge şekilde yükleyip olacak değil paketini takmak Ave irade ne yük ne de paketini takmak B. ( "Imports", Sonuçta bu paket yazarlar ad mekanizmasını kullanıyor ve bu paket beklediğini Akullanıyor olacak "Imports"herhangi fonksiyonlara noktasına B. O erişmeleri gerektiğini) paketinde herhangi fonksiyonlara Fonksiyonlarınızdan tarafından Aramalar Apaket işlevleri itimat Birade sonuç olarak başarısız olur.

Yalnızca iki çözüm şunlardan biridir:

1. Paketinizin Abir "Depends"yönerge kullanarak paket eklemesini sağlayın .
2. Uzun vadede daha iyi, paketin bakımcısıyla iletişime Ageçin ve ad alanlarını oluşturmak için daha dikkatli bir iş yapmalarını isteyin ( bu ilgili cevapta Martin Morgan'ın ifadesiyle ).

Hadley Wickham kolay bir açıklama yapıyor ( http://r-pkgs.had.co.nz/namespace.html ):

Bir paketi ikisinden birinde listelemek Dependsveya Importsgerektiğinde yüklenmesini sağlar. Temel fark, Importspaketi sadece yüklediği yere Dependseklemesidir. Başka hiçbir fark yok. [...]

Aksi iyi bir neden olmadığı sürece, sen her zaman liste paketleri gerektiği Importsdeğil Depends. Bunun nedeni, iyi bir paketin kendi kendine yetmesi ve küresel ortamda (arama yolu dahil) değişiklikleri en aza indirmesidir. Bunun tek istisnası, paketinizin başka bir paketle birlikte kullanılmak üzere tasarlanmış olmasıdır. Örneğin, analog paket veganın üzerine inşa edilir. Vegan olmadan işe yaramaz, bu yüzden Dependsyerine vegan var Imports. Benzer şekilde, ggplot2 gerçekten İçe Aktarmaktan ziyade ölçeklere bağlı olmalıdır.

SfDA'daki Odalar, bu paket bir 'ad alanı' mekanizması kullandığında ve artık tüm paketlerin bunlara sahip olması gerektiği için 'İthalat'ı kullanmasını söylüyor, o zaman yanıt her zaman' İthalatlar 'olabilir. Geçmişte paketler aslında ad alanlarına sahip olmadan yüklenebilirdi ve bu durumda Depends'i kullanmanız gerekirdi.

Hangisini kullanacağınıza karar vermenize yardımcı olacak basit bir soru:

Paketiniz, son kullanıcının başka bir paketin işlevlerine doğrudan erişmesini gerektiriyor mu?

• HAYIR -> İthalatlar (en yaygın cevap)
• EVET -> Bağlıdır

"Bağımlı" seçeneğini kullanmanız gereken tek zaman, paketinizin bir eklenti veya başka bir paketin arkadaşı olduğu, son kullanıcınızın hem paketinizdeki hem de kodundaki "Bağımlı" paketindeki işlevleri kullanacağı zamandır. Son kullanıcınız yalnızca işlevlerinizle arabirim oluşturacaksa ve diğer paket yalnızca perde arkasında çalışacaksa, bunun yerine 'İçe Aktarmalar'ı kullanın.

Bu konudaki uyarı, genellikle yapmanız gerektiği gibi 'İçe Aktarmalar'a bir paket eklerseniz, kodunuzun tam ad alanı sözdizimini kullanarak, örneğin dplyr::mutate()sadece yerine bu paketin işlevlerine başvurması gerektiğidir mutate(). Kodu okumayı biraz daha hantal yapar, ancak daha iyi ambalaj hijyeni için ödenmesi gereken küçük bir bedeldir.