R S4 классы с одинаковым именем из разных пакетов

Question

Предположим, что есть два пакета.

Package_A имеет этот класс:

setClass("Person", 
         slots = c(
           name = "character", 
           age = "numeric"
         )
)

setGeneric("age", function(x) standardGeneric("age"))
setMethod("age", "Person", function(x) x@age)

Package_B имеет аналогичный класс:

setClass("Person", 
         slots = c(
           name = "character", 
           age = "numeric"
         )
)

setGeneric("age", function(x) standardGeneric("age"))
setMethod("age", "Person", function(x) x@age * 10) # notice the difference here

Итак, пользователь загрузил оба пакета в свою рабочую среду:

library(Package_A)
library(Package_B)

В рабочей среде этого пользователя, как R разрешает путаницу при создании объекта "Человек":

john <- new("Person", name = "John Smith", age = 7)

В рабочей среде этого пользователя, как R разрешает вызов правильного метода:

age(john)

Answer 1

Доступ к классам из определенного пакета

getClass()

принимает classRepresentationобъект, который вы можете получить, используяgetClass. Например, new(getClass('className', where='packageName')). Однако обратите внимание, что это не сработает, если вы еще не импортировали пакет, а также определили новый класс с тем же именем. Я демонстрирую эту проблему здесь:

      install.packages('lookupTable')
setClass('lookupTable', slots = c(notworking='numeric'))
new(getClass('lookupTable', where='lookupTable'))
#> An object of class "lookupTable"
#> Slot "notworking":
#> numeric(0)

(он напечатал «неработающий» слот, что означает, что он создает экземпляр моего пользовательского класса, а не правильной версии пакета)

new(classNameWithAttribute)

Есть странная, но задокументированная особенностьnew(), что позволяет установить packageатрибут имени класса, который на самом деле работает отлично (т.е. не имеет проблемы, упомянутой выше), если немного подробно:

      name = 'className'
attr(name, 'package') = 'packageName'
new(name)

Однако нет причин, по которым вы не могли бы превратить это в функцию многократного использования:

      new = function(cls, pkg, ...){
    attr(cls, 'package') = pkg
    methods::new(cls, ...)
}
new('className', 'packageName')

Хороший дизайн упаковки

Конечно, всего этого можно избежать, если упаковщики классов S4 предусмотрят один из двух механизмов:

Экспорт значения

setClass()имеет как побочный эффект (сохранение класса в реестре), так и возвращаемое значение (функция генератора классов). Таким образом, если упаковщик решит сохранить и экспортировать возвращаемое значение в NAMESPACE, мы можем получить к нему доступ позже:

      # In package "myPackage"
myClass = setClass('myClass')

# In package's NAMESPACE
export(myClass)

# In user's script
new(myPackage::myClass)

Например, вы можете проверить это с помощью того же тестового пакета, что и раньше:

      install.packages('lookupTable')
new(lookupTable::lookupTable)

Экспорт функции-конструктора

Это стандартная практика в биокондукторе. Они определяют функцию-конструктор с тем же именем, что и сам класс. Затем вы можете получить доступ к функции конструктора, используя ::, и назовите его вместо new:

      install.packages("BiocManager")
BiocManager::install("IRanges")

new("IRanges")
# Equivalent to 
IRanges::IRanges()