File: utils-getS4.R

package info (click to toggle)
fbasics 4041.97-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,016 kB
  • sloc: ansic: 740; makefile: 14
file content (166 lines) | stat: -rw-r--r-- 4,339 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Library General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR Description. See the
# GNU Library General Public License for more details.
#
# You should have received a copy of the GNU Library General
# Public License along with this library; if not, write to the
# Free Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA 02111-1307 USA


################################################################################
# FUNCTION:                 DESCRIPTION:
#  getCall                   Extracts the call slot from a S4 object
#  getModel                  Extracts the model slot from a S4 object
#  getTitle                  Extracts the title slot from a S4 object
#  getDescription            Extracts the description slot from a S4 object
#  getSlot                   Extracts a specified slot from a S4 object
#  getArgs                   Shows the arguments of a S4 functiong
################################################################################


if(getRversion() < "2.14") {
  getCall <- function(x) slot(x, "call")
} ## since 2.14.0, getCall() is an S3 generic in 'stats'
## *AND* its default method also works for S4 and a "call" slot

# ------------------------------------------------------------------------------


getModel <-
  function(object)
  {
    # A function implemented by Tobias Setz
    
    # FUNCTION: 
    
    # Return Value:
    UseMethod("getModel")
  }

getModel.default <-
  function(object)
  {
    # A function implemented by Rmetrics
    
    # Description:
    #   gets the "model" slot from an object of class 4
    
    # Arguments:
    #   object - an object of class S4
    
    # FUNCTION:
    
    # Return Value:
    slot(object, "model")
  }


# ------------------------------------------------------------------------------


getTitle <-
  function(object)
  {
    # A function implemented by Rmetrics
    
    # Description:
    #   gets the "title" slot from an object of class 4
    
    # Arguments:
    #   object - an object of class S4
    
    # FUNCTION:
    
    # Return Value:
    slot(object, "title")
  }


# ------------------------------------------------------------------------------


getDescription <-
  function(object)
  {
    # A function implemented by Rmetrics
    
    # Description:
    #   Extracts the "description" slot from an object of class 4
    
    # Arguments:
    #   object - an object of class S4
    
    # FUNCTION:
    
    # Return Value:
    slot(object, "description")
  }


# ------------------------------------------------------------------------------


getSlot <-
  function(object, slotName)
  {
    
    # a simple wrapper around slot to avoid compatibilty troubles with
    # other packages.
    
    # FUNCTION:
    
    slot(object, slotName)
  }


# ------------------------------------------------------------------------------


getArgs <-
  function(f, signature = character())
  {
    # A function implemented by Diethelm Wuertz
    
    # Description:
    #   Shows the arguments of a S4 functiong
    
    # Arguments:
    #   f - a generic function or the character-string name of one
    #   signature - the signature of classes to match to the arguments
    #       of f
    
    # Note:
    #   such a function is missing in the methods package,
    #   see, e.g he function getMethod()
    
    # FUNCTION:
    
    # Get arguments:
    fun <- getMethod(f, signature)@.Data
    test <- class(try(body(fun)[[2]][[3]], silent = TRUE))
    
    if (test == "function") {
      ans <- args(body(fun)[[2]][[3]])
    } else {
      ans <- args(fun)
    }
    
    cat(substitute(f), ",", paste(signature, collapse = ","), ":\n",
        sep = "")
    
    # Return Value:
    ans
  }


################################################################################