The R Project SVN R

Rev

Rev 71366 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 71366 Rev 71420
Line 1... Line 1...
1
% File src/library/methods/man/setGeneric.Rd
1
% File src/library/methods/man/setGeneric.Rd
2
% Part of the R package, https://www.R-project.org
2
% Part of the R package, https://www.R-project.org
3
% Copyright 1995-2015 R Core Team
3
% Copyright 1995-2016 R Core Team
4
% Distributed under GPL 2 or later
4
% Distributed under GPL 2 or later
5
 
5
 
6
\name{setGroupGeneric}
6
\name{setGroupGeneric}
7
\alias{setGroupGeneric}
7
\alias{setGroupGeneric}
8
\title{Create a Group Generic Version of a Function}
8
\title{Create a Group Generic Version of a Function}
Line 22... Line 22...
22
\usage{
22
\usage{
23
setGroupGeneric(name, def= , group=list(), valueClass=character(),
23
setGroupGeneric(name, def= , group=list(), valueClass=character(),
24
                knownMembers=list(), package= , where= )
24
                knownMembers=list(), package= , where= )
25
}
25
}
26
\arguments{
26
\arguments{
27
  \item{name}{ The character string name of the generic function.
27
  \item{name}{the character string name of the generic function.
28
  }
28
   }
29
  \item{def}{A function object.  There isn't likely to be an existing
29
  \item{def}{A function object.  There isn't likely to be an existing
30
      nongeneric of this name, so some function needs to be supplied.
30
    nongeneric of this name, so some function needs to be supplied.  Any
31
      Any known member or other function with the same argument list will do, because the group generic cannot be called
31
    known member or other function with the same argument list will do,
32
      directly. 
-
 
33
  }
-
 
34
  \item{group, valueClass, signature, simpleInheritanceOnly}{ Arguments to pass to \code{\link{setGeneric}}.
32
    because the group generic cannot be called directly.
35
  }
33
  }
36
  \item{package, where, useAsDefault, genericFunction}{ Passed to \code{\link{setGeneric}}, but
34
  \item{group, valueClass}{arguments to pass to
37
      obsolete and to be avoided.
35
    \code{\link{setGeneric}}.
38
  }
36
  }
39
  \item{knownMembers}{
-
 
40
    The names of functions that are
37
  \item{knownMembers}{the names of functions that are
41
    known to be members of this group.  This information is used to
38
    known to be members of this group.  This information is used to
42
    reset cached definitions of the member generics when information
39
    reset cached definitions of the member generics when information
43
    about the group generic is changed.
40
    about the group generic is changed.
44
  }
41
  }
-
 
42
  \item{package, where}{passed to \code{\link{setGeneric}}, but
-
 
43
    obsolete and to be avoided.}
45
}
44
}
46
\value{
45
\value{
47
  The \code{setGroupGeneric} function exists for its side effect: saving the
46
  The \code{setGroupGeneric} function exists for its side effect: saving the
48
  generic function to allow methods to be specified later.  It returns
47
  generic function to allow methods to be specified later.  It returns
49
  \code{name}.
48
  \code{name}.