setGenericS3 {R.methodsS3} | R Documentation |
Creates an S3 generic function
Description
Note that this method is a internal method called by
setMethodS3
() and there is no reason for calling it directly!
Creates a generic function in S3 style, i.e. setting a
function with name name
that dispatches the method name
via UseMethod
. If there is already a function named name
that function is renamed to name.default
.
Usage
## Default S3 method:
setGenericS3(name, export=TRUE, envir=parent.frame(), dontWarn=getOption("dontWarnPkgs"),
validators=getOption("R.methodsS3:validators:setGenericS3"), overwrite=FALSE, ...)
Arguments
name |
The name of the generic function. |
export |
A |
envir |
The environment for where this method should be stored. |
dontWarn |
If a non-generic method with the same name is found it
will be "renamed" to a default method. If that method is found in
a package with a name that is not found in |
validators |
An optional |
... |
Not used. |
overwrite |
If |
Author(s)
Henrik Bengtsson
See Also
To define a method for a class see setMethodS3
().
For more information about S3, see UseMethod
().
Examples
myCat.matrix <- function(..., sep=", ") {
cat("A matrix:\n")
cat(..., sep=sep)
cat("\n")
}
myCat.default <- function(..., sep=", ") {
cat(..., sep=sep)
cat("\n")
}
setGenericS3("myCat")
myCat(1:10)
mat <- matrix(1:10, ncol=5)
myCat(mat)