Learn R Programming

MutableRanges (version 0.6.2)

setTransformGRangesClass: Define TransformGRanges subclass

Description

This function is a utility for defining subclasses of TransformGRanges, a ProxyGRanges derivative that transforms one or more columns in the element metadata. The transformation is implemented by the subclass.

Usage

setTransformGRangesClass(prefix, transform, reverseTransform = NULL, parameters = list(), where = topenv(parent.frame()), ...)

Arguments

prefix
The string prepended onto TransformGRanges to form the class name.
transform
The function implementing the transformation, taking the raw GenomicRanges and any parameters as arguments.
reverseTransform
The function implementing the reverse transform, or NULL if reverse transformation is impossible.
parameters
Named list of parameters class names, just how fields are specified to setRefClass. The parameter values are passed as individual arguments to transform and reverseTransform.
where
The environment in which to define the class and assign the constructors.
...

Value

  • The generator object for the class. Besides defining a derivative of TransformGRanges, a class for the storing the parameters is also defined, and constructors for both classes are assigned into where.

See Also

This is just a wrapper for setProxyGRangesClass.