R語言類

R語言的類有S3類和S4類，S3類用的比較廣，創建簡單粗糙但是靈活，而S4類比較精細，具有跟C++一樣嚴格的結構。這裏我們主要講S3類。

S3類的結構

S3類內部是一個list，append某個list類名稱，就能成為該類。list裏面的內容就是我們所說的屬性.
首先創建一個list

me <- list(seq = "ATGC", length = nchar("ATGC"))
me
$seq
[1] "ATGC"

$length
[1] 4

現在me這個list只屬於list類

me
$seq
[1] "ATGC"

$length
[1] 4

attr(,"class")
[1] "list"   "DNAseq"
 

然後我們append 一個類名"DNAseq"，就這樣我們創建了一個DNAseq類，類的屬性有seq和length，值為ATGC和4

class(me) <- append(class(me), "DNAseq")
class(me)
[1] "list"   "DNAseq"

我們可以通過普通的list的方法來獲得類的屬性，比如

me$seq
[1] "ATGC"
me$length
[1] 4

S3類的創建

簡單直接的構建方法

依據剛才的類的結構，我們用函數進行類的構建，函數的輸入是要傳入進行類的初始化的值，而函數的返回就是新生成的類。這樣我們就可以根據不同的初始化值進行類的實例化。
首先構造一個類

# Straight forward approach
DNAseq <- function(seq = "ATGCATGCATGCATGCATGC"){
  me <- list(
    seq = seq,
    length = nchar(seq)
  )
  # Set the name for the class
  class(me) <- append(class(me), "DNAseq")
  return(me)
}

類的實例

seq1 <- DNAseq()
seq1

$seq
[1] "ATGCATGCATGCATGCATGC"

$length
[1] 20

attr(,"class")
[1] "list"   "DNAseq"
 

局部環境構建類的方法

當然本質還是list，但是巧妙的利用了函數運行時的局部環境。函數運行時，內部的環境是和外界隔離的，在函數內創建的變量不會影響函數外。而這種方法巧妙的取出了這個內部環境的指針，並且將它放到了list裏面。最後append類名。在環境裏面存放了list的指針，而在list裏面又存放了環境的指針。之所以內部環境沒有消失，我猜想是因為返回的類裏面具有環境的指針的引用，所以內存沒有釋放，是一個智能指針，當然，我沒有對這深究。這次屬性並不是直接存放在list裏面，而是存放在函數裏面的環境中。而list裏面放著：方法和當前環境的指針。assign是對環境中某個變量賦值，可以用get函數中獲得環境中變量的值。

# Local enviroment approach
DNASeq <- function(seq = "ATGCATGCATGCATGCATGC"){
  ## Get the enviroment for this
  thisEnv <- environment()
  
  seq <- seq
  length <- nchar(seq)
  
  ## Create the list used to represent the
  ## object for this class
  me <- list(
    ## Define the enviroment where this list is defined so
    ## that I can refer to it
    thisEnv = thisEnv,
    
    ## Method to refer to the current enviroment
    getEnv = function(){
      return(get("thisEnv", thisEnv))
    }
  )
    
    ## Define the value of list within the 
    ## current enviroment
    assign("this", me, envir = thisEnv)
    
    ##Set the name for the class
    class(me) <- append(class(me), "DNASeq")
    return(me)
}

實例化

seq2 <- DNASeq()
seq2
$thisEnv
<environment: 0x8e86a20>

$getEnv
function () 
{
    return(get("thisEnv", thisEnv))
}
<environment: 0x8e86a20>

$getseq
function () 
{
    return(get("seq", thisEnv))
}
<environment: 0x8e86a20>

$reverseComplement
function () 
{
    print("Calling the reverseComplement function of DNASeq class")
    to_base <- c("A", "T", "G", "C")
    names(to_base) <- c("T", "A", "C", "G")
    trans_seq_vect <- to_base[unlist(strsplit(get("seq", thisEnv), 
        split = ""))]
    trans_rev_vect <- trans_seq_vect[length(trans_seq_vect):1]
    newseq <- paste0(trans_rev_vect, collapse = "")
    return(DNASeq(newseq))
}
<environment: 0x8e86a20>

attr(,"class")
[1] "list"   "DNASeq"

獲得裏面的seq屬性的值，這裏使用get獲得環境中的變量的值

get("seq", seq2$getEnv())
[1] "ATGCATGCATGCATGCATGC"

當然，如果使用這種方法生成的類，我們獲得屬性通常不再函數外用get，因為這樣並不像面向對象的用法，我們會在給類一個方法，某個類調用這個方法之後就可以獲得某個屬性的值，比如可以在list中再寫一個函數，getseq，就等於get("seq", thisEnv)，這樣就可以面向對象的使用seq2$getseq()來獲得seq屬性。當我們列表中添加方法時，註意應該用遵循列表的格式，用",”分開不同的方法或者不同的值。

創建方法

類中除了含有屬性外，肯定還得含有方法。上面我們講到用局部環境變量創建S3類時可以在list裏面存放方法。當然還有一種比較普遍的，在兩種方式創建的S3類中都能使用的創建方法的途徑。使用某方法.某類來創建某類的方法。比如print.gg就是對gg類的print的方法。但是在創建這種方法之前我們首先得用這個方法的名字創建一個函數，這樣運行函數時首先進入這個函數，然後在函數裏面使用useMethod函數，在環境中尋找該類的該方法。雖然下面的代碼比較復雜，但是重點時看UseMethod。

# Creating methods
reverseComplement <- function(object){
  UseMethod("reverseComplement", object)
}
reverseComplement.default <- function(object){
  print("The class of this object can not be found")
}

# Straight forward approach
#
# For S3 classes created by Straight forward approach
reverseComplement.DNAseq <- function(object){
  print("Calling the reverseComplement function of DNAseq class")
  ## Compelement according to the vector below
  to_base <- c("A", "T", "G", "C")
  names(to_base) <- c("T", "A", "C", "G")
  ## Transform long charactor to vector and complement
  trans_seq_vect <- to_base[unlist(strsplit(object$seq, split = ""))]
  ## Reverse
  trans_rev_vect <- trans_seq_vect[length(trans_seq_vect):1]
  ## Collape to long character
  newseq <- paste0(trans_rev_vect, collapse = "")
  # Return a new DNAseq class
  return(DNAseq(newseq))
}

# For S3 classed created by local enviroment approach
reverseComplement.DNASeq <- function(object){
  print("Calling the reverseComplement function of DNASeq class")
  ## Compelement according to the vector below
  to_base <- c("A", "T", "G", "C")
  names(to_base) <- c("T", "A", "C", "G")
  ## Transform long charactor to vector and complement
  trans_seq_vect <- to_base[unlist(strsplit(get("seq", seq2$getEnv()), split = ""))]
  ## Reverse
  trans_rev_vect <- trans_seq_vect[length(trans_seq_vect):1]
  ## Collape to long character
  newseq <- paste0(trans_rev_vect, collapse = "")
  # Return a new DNASeq class
  return(DNASeq(newseq))
}

上面還有一個default函數，表示默認的方法，如果該類找不到該類匹配的方法，就會使用默認方法。

類繼承

S3類可以使用繼承，在原來類的基礎上再append一個新的類名即為新的類，用NextMethod可以調用下一層類的方法。
創建一個primer類繼承DNAseq類

#inheritance 
Primer <- function(seq = "ATGCATGCATGCATGCATGCGGCC"){
  pr <- strtrim(seq, 20)
  me <- DNAseq(pr)
  class(me) <- append(class(me), "Primer")
  return(me)
}
Primer1 <- Primer()
Primer1
$seq
[1] "ATGCATGCATGCATGCATGC"

$length
[1] 20

attr(,"class")
[1] "list"   "DNAseq" "Primer"

調用方法的時候會按照從左到右的順序，再這個例子中，默認先調用DNAseq的方法，如果想要調用Primer類的方法，首先寫一個Primer的reverseComplement方法

# Creating methods 
reverseComplement.Primer <- function(object){
  print("Running reverseComplement of Primer class")
}

然後在DNAseq類中調用下一類的方法，使用NextMethod

reverseComplement.DNAseq <- function(object){
  print("Calling the reverseComplement function of DNAseq class")
  NextMethod("reverseComplement", object)
  ## Compelement according to the vector below
  to_base <- c("A", "T", "G", "C")
  names(to_base) <- c("T", "A", "C", "G")
  ## Transform long charactor to vector and complement
  trans_seq_vect <- to_base[unlist(strsplit(object$seq, split = ""))]
  ## Reverse
  trans_rev_vect <- trans_seq_vect[length(trans_seq_vect):1]
  ## Collape to long character
  newseq <- paste0(trans_rev_vect, collapse = "")
  # Return a new DNAseq class
  return(DNAseq(newseq))
}

reverseComplement(Primer1)
[1] "Calling the reverseComplement function of DNAseq class"
[1] "Running reverseComplement of Primer class"
$seq
[1] "GCATGCATGCATGCATGCAT"

$length
[1] 20

attr(,"class")
[1] "list"   "DNAseq"

reverseComplement(seq1)
[1] "Calling the reverseComplement function of DNAseq class"
[1] "The class of this object can not be found"
$seq
[1] "GCATGCATGCATGCATGCAT"

$length
[1] 20

attr(,"class")
[1] "list"   "DNAseq"

R語言S3類的理解與構建