Usage
setProxyGRangesClass(prefix, compute = NULL, reverseCompute = NULL,
arity = c("auto", "unary", "binary", "multinary"),
destructive = TRUE, parameters = list(),
parameterDefaults = list(),
extraFields = list(), extraMethods = list(),
contains = "ProxyGRanges", where = topenv(parent.frame()), ...)
Arguments
prefix
Prefix for the class name, appended to GRanges
compute
The function that computes on the data. Passed an
argument for each operand GenomicRanges
, as well as an
argument for each parameter. May be NULL
if not implemented,
which is useful when defining virtual subclasses. If arity
is multinary and this function takes two formal arguments, a
wrapper is produced using Reduce
. reverseCompute
The function that performs the reverse
computation, i.e., identical(x, reverseCompute(compute(x)))
should be TRUE
, at least in theory. Often, reverse
computation is not possible. If this always true for a given
operation, NULL
may be provided, in which case attempts to
send data down the reverse pipeline will fail.
arity
The number of operands that a given operation
supports. This is mostly for allowing interfaces like GUIs to
accurately convey the capabilities of an operation. As an example, a
filter would typically be unary, whereas addition would
be binary, and union could be multinary. By
default, the arity is automatically determined from the formal
arguments of compute
. If ...