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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/method-register.R
\name{method<-}
\alias{method<-}
\title{Register an S7 method for a generic}
\usage{
method(generic, signature) <- value
}
\arguments{
\item{generic}{A generic function, i.e. an \link[=new_generic]{S7 generic},
an \link[=new_external_generic]{external generic}, an \link[=UseMethod]{S3 generic},
or an \link[methods:setGeneric]{S4 generic}.}
\item{signature}{A method signature.
For S7 generics that use single dispatch, this must be one of the
following:
\itemize{
\item An S7 class (created by \code{\link[=new_class]{new_class()}}).
\item An S7 union (created by \code{\link[=new_union]{new_union()}}).
\item An S3 class (created by \code{\link[=new_S3_class]{new_S3_class()}}).
\item An S4 class (created by \code{\link[methods:getClass]{methods::getClass()}} or \code{\link[methods:new]{methods::new()}}).
\item A base type like \link{class_logical}, \link{class_integer}, or \link{class_numeric}.
\item A special type like \link{class_missing} or \link{class_any}.
}
For S7 generics that use multiple dispatch, this must be a list of any of
the above types.
For S3 generics, this must be a single S7 class.
For S4 generics, this must either be an S7 class, or a list that includes
at least one S7 class.}
\item{value}{A function that implements the generic specification for the
given \code{signature}.}
}
\value{
The \code{generic}, invisibly.
}
\description{
A generic defines the interface of a function. Once you have created a
generic with \code{\link[=new_generic]{new_generic()}}, you provide implementations for specific
signatures by registering methods with \verb{method<-}.
The goal is for \verb{method<-} to be the single function you need when working
with S7 generics or S7 classes. This means that as well as registering
methods for S7 classes on S7 generics, you can also register methods for
S7 classes on S3 or S4 generics, and S3 or S4 classes on S7 generics.
But this is not a general method registration function: at least one of
\code{generic} and \code{signature} needs to be from S7.
Note that if you are writing a package, you must call \code{\link[=methods_register]{methods_register()}}
in your \code{.onLoad}. This ensures that all methods are dynamically registered
when needed.
}
\examples{
# Create a generic
bizarro <- new_generic("bizarro", "x")
# Register some methods
method(bizarro, class_numeric) <- function(x) rev(x)
method(bizarro, new_S3_class("data.frame")) <- function(x) {
x[] <- lapply(x, bizarro)
rev(x)
}
# Using a generic calls the methods automatically
bizarro(head(mtcars))
}
|
