Objecten en klassen in R

Klasse in R

Een klasse is het blauwdruk waarmee je een object maakt en dat zijn ledematenvariabelen en attributen bevat.

Zoals eerder besproken zijn er in R twee klassensystemen: S3 en S4.

S3-klasse

Deze klassen helpen bij het overbelasten van functies door ze op te splitsen in generieken en methoden.

functies = generiek + methoden

S3 is heel anders dan andere programmeertalen zoals C#, Java, enz. Omdat het eenvoudig te implementeren is, gebruikt het alleen het eerste argument voor dispatch. Daarom heb je als programmeur niet heel veel voorkennis nodig.

S3 werkt door een strikte naamgevingsconventie van generiek.punt.klasse te definiëren.

                             generic.class

De argumenten van methoden moeten de argumenten van de generiek bevatten en de methode moet een ...arg bevatten.

Construeren met voorbeeld van een S3-klasse

In het volgende voorbeeld zie je hoe je een S3-klasse construeert: er wordt een lijst gemaakt waarin componenten worden doorgegeven, samen met een juiste classname, en vervolgens wordt het resultaat afgedrukt.

In het volgende voorbeeld bevat 'studentBio' een lijst waarin componenten als lijst worden doorgegeven: 'student_name', 'student_age' en 'student_contact'. De klasse heet 'Student Info' en 'studentBio' is de nieuw aangemaakte klasse waarvan de waarden hieronder worden weergegeven.

studentBio <- list(studentName = "Harry Potter", studentAge = 19, studentContact="London")
class(studentBio) <- "StudentInfo"
studentBio

$studentName
[1] "Harry Potter"

$studentAge
[1] 19

$studentContact
[1] "London"

attr(,"class")
[1] "StudentInfo"

De bovenstaande code geeft de volgende output:

$studentName
 "Harry Potter"

$studentAge
19

$studentContact
"London"

attr(,"class")
"StudentInfo"

Als je nog niet zo zeker bent over het schrijven van functies in R, lees dan A Tutorial on Using Functions in R!

Je eigen generieke methode maken in S3

Hieronder implementeer je je generieke functie met behulp van de volgende code.

De onderstaande code toont de generieke functie 'contact' waarbij de functie met het object als argument wordt aangeroepen. Ook wordt 'UseMethod' gebruikt met de generieke functie 'contact', waar de 'dispatch' van de methode plaatsvindt: het proces waarbij het resultaat varieert op basis van de doorgegeven argumenten.

contact <- function(object) {
UseMethod("contact")
}

Laten we een methode maken voor de specifieke klasse die je eerder hebt aangemaakt, 'StudentInfo'. De methode 'contact' gevolgd door puntnotatie met de klasse 'StudentInfo' wordt gebruikt; in de functiebody wordt het attribuut 'studentContact' benaderd met '$'.

contact.StudentInfo <- function(object) {
cat("Your contact is", object$studentContact, "\n")
}
contact(studentBio)

Your contact is London

De bovenstaande code gebruikt object$studentContact, waarbij het object als argument aan de functie is doorgegeven en met '$' het attribuut 'studentContact' wordt benaderd, wat de onderstaande output oplevert.

Your contact is London

S4-klasse

De S4-klasse is strikter, conventioneler en sluit nauwer aan bij objectgeoriënteerde concepten. De klassen worden weergegeven door de formele klassedefinities van S4. Concreet heeft S4 setter- en getterfuncties voor methoden en generieken. In vergelijking met de S3-klasse kan S4 multiple dispatch faciliteren.

We bekijken de hierboven besproken R-klassen door ze te maken en te bespreken met een voorbeeld.

Een S4-klasse wordt gedefinieerd met de setClass-functie.

 setClass()

Construeren met voorbeeld van een S4-klasse

Zoals eerder besproken wordt de S4-klasse gedefinieerd met de setClass()-methode. Je gebruikt de setClass()-methode om de S4-klasse te maken en te definiëren. We gebruiken een subroutine om te controleren of de data consistent is (validatie) en om standaardwaarden in te stellen (het paradigma).

Hieronder staat de code om de klasse en zijn slots te definiëren:

Het volgende wordt gebruikt om een klasse te definiëren, ook wel 'prototype' genoemd, waarin de slots zijn gedefinieerd: de classname is 'employee', name is een character, id is numeric en contact is een character.

setClass("employee", slots=list(name="character", id="numeric", contact="character"))

Met de volgende code kun je specifieke instanties of objecten van S4 maken.

Laten we een object maken met 'new' met binnenin de classname 'employee', waarbij de slots name, id en contact een waarde krijgen.

obj <- new("employee",name="Steven", id=1002, contact="West Avenue")
obj

An object of class "employee"
Slot "name":
[1] "Steven"

Slot "id":
[1] 1002

Slot "contact":
[1] "West Avenue"

An object of class "employee"
Slot "name":
"Steven"

Slot "id":
1002

Slot "contact":
"West Avenue"

De bovenstaande output laat zien dat het aangemaakte object van klasse "employee" is en dat de slot "name" de waarde "Steven" heeft, de slot "id" de waarde 1002 en de slot "contact" de waarde "West Avenue".

Functie en commando's

Om te controleren of een object een S4-object is, kunnen de volgende twee commando's worden gebruikt:

Het commando 'is.object(obj)' controleert of een variabele of instantie naar een object verwijst.

is.object(obj)

TRUE

De bovenstaande code geeft de volgende output:

TRUE

Het commando 'is.S4(obj)' controleert of een variabele of instantie een S4-object is.

isS4(obj)

TRUE

De bovenstaande code geeft de volgende output:

TRUE

De slotwaarde benaderen en wijzigen

De slot benaderen

De slot kun je benaderen met "@" in plaats van "$".

'obj@name' wordt gebruikt waarbij je de objectnaam met de slotnaam gebruikt om de naam 'Steven' te benaderen; hetzelfde geldt voor 'obj@id'.

obj@name
obj@id

'Steven'

1002

De bovenstaande code geeft de volgende output:

'Steven'
1002

De slot wijzigen

We wijzigen de slotwaarde met de toekenningsoperator ("<-") waarbij aan 'obj@contact' een nieuwe waarde "North Avenue" wordt toegekend.

obj@contact <- "North Avenue"
obj

An object of class "employee"
Slot "name":
[1] "Steven"

Slot "id":
[1] 1002

Slot "contact":
[1] "North Avenue"

De bovenstaande code geeft de volgende output:

An object of class "employee"
Slot "name":
"Steven"

Slot "id":
1002

Slot "contact":
"North Avenue"

De output laat zien dat de slot "contact" is gewijzigd van "West Avenue" naar "North Avenue".

Als alternatief kun je 'slot()' gebruiken om de waarde te wijzigen.

'slot(obj, "id")' geeft aan dat de slot "id" wordt gewijzigd door toekenning van 1004, en het resultaat wordt afgedrukt met 'obj'.

slot(obj,"id") <- 1004
obj

An object of class "employee"
Slot "name":
[1] "Steven"

Slot "id":
[1] 1004

Slot "contact":
[1] "North Avenue"

An object of class "employee"
Slot "name":
"Steven"

Slot "id":
1004

Slot "contact":
"North Avenue"

De bovenstaande output laat zien dat de slot "id" is gewijzigd van 1002 naar 1004.

Je eigen generieke methode maken in S4

Laten we een functie maken die helpt om de output naar wens te printen, waarbij 'setMethod()' en de generieke functie 'show()' worden gebruikt. Ook worden alle slotwaarden benaderd met '@' en hun namen afgedrukt. Tot slot wordt de output verkregen met behulp van 'obj'.

setMethod("show",
"employee",
function(object) {
cat("Name:",object@name, "\n")
cat("Id:",object@id, "\n")
cat("Contact:", object@contact, "\n")
}
)
obj

Name: Steven
Id: 1004
Contact: North Avenue

Name: Steven
Id: 1004
Contact: North Avenue

De bovenstaande output laat zien dat de resultaten worden afgedrukt in de vorm van slotnamen met de bijbehorende slotwaarden.

Gefeliciteerd

Gefeliciteerd, je bent aan het einde van deze tutorial gekomen!

In deze tutorial heb je geleerd over objectgeoriënteerd programmeren (OOP) samen met R-objecten, verschillende klassen zoals S3 en S4, hoe je ze opzet, hoe je hun generieke functies maakt met voorbeelden, en nog veel meer.

Wil je meer leren over R? Bekijk de cursussen van DataCamp:

Object-Oriented Programming with S3 and R6 in R