gdreduce {BSgenome}R Documentation

Reduces arguments to a single GenomeData instance

Description

This function accepts one or more objects that are reduced, with a user-specified function, to a single GenomeData instance.

Usage

gdreduce(f, ..., init, right = FALSE, accumulate = FALSE, gdArgs = list()) 

Arguments

f An object of class "function", accepting two instances of classes appropriate for the ... arguments, and returning an object suitable for subsequent use in f and incorporation into GenomeData.
... Objects to be reduced. All objects should be of the same class, as dictated by methods defined on gdreduce A function to be applied to each chromosome-level sub-element of X.
init An R object of the same kind as the elements of ....
right A logical indicating whether to proceed from left to right (default) or right to left.
accumulate A logical indicating whether the successive reduce combinations should be accumulated. By default, only the final combination is used.
gdArgs Additional arguments passed to the GenomeData constructor used to assemble the final object.

Value

An object of class GenomeData, containing elements corresponding to the intersection of all named elements of ....

Author(s)

Martin Morgan

See Also

Reduce

Examples

showMethods(gdreduce, where=getNamespace("BSgenome"))

[Package BSgenome version 1.18.3 Index]