start: Start, end, width generic getters and setters

In nturaga/BiocGenerics: S4 generic functions for Bioconductor

Description

Get or set the start, end, or width of an object.

NOTE: This man page is for the start, `start<-`, end, `end<-`, width, and `width<-` S4 generic functions defined in the BiocGenerics package. See ?stats::start for the start and end S3 generics defined in the stats package.

Usage

start(x, ...)
start(x, ...) <- value

end(x, ...)
end(x, ...) <- value

width(x)
width(x, ...) <- value

Arguments

x	An object containing start, end, and width values.
...	Additional arguments, for use in specific methods.
value	The start, end, or width values to set on x.

Value

See specific methods defined in Bioconductor packages.

See Also

• stats::start in the stats package for the start and end S3 generics.

• showMethods for displaying a summary of the methods defined for a given generic function.

• selectMethod for getting the definition of a specific method.

• start,IRanges-method in the IRanges package for examples of specific start, end, and width methods (defined for IRanges objects).

• BiocGenerics for a summary of all the generics defined in the BiocGenerics package.

Examples

## start getter:
start
showMethods("start")

library(IRanges)
showMethods("start")
selectMethod("start", "IRanges")  # start getter for IRanges objects

## start setter:
`start<-`
showMethods("start<-")
selectMethod("start<-", "IRanges")  # start setter for IRanges objects

## end getter:
end
showMethods("end")
selectMethod("end", "IRanges")  # end getter for IRanges objects

## end setter:
`end<-`
showMethods("end<-")
selectMethod("end<-", "IRanges")  # end setter for IRanges objects

## width getter:
width
showMethods("width")
selectMethod("width", "IRanges")  # width getter for IRanges objects

## width setter:
`width<-`
showMethods("width<-")
selectMethod("width<-", "IRanges")  # width setter for IRanges objects

nturaga/BiocGenerics documentation built on May 7, 2019, 11:15 a.m.