getSummary: Accessor method for the summary slot of the BSFDataSet object

In ZarnackGroup/BindingSiteFinder: Binding site defintion based on iCLIP data

Accessor method for the summary slot of the BSFDataSet object

Description

The summary slot is used to track information of the filtering steps applied in the makeBindingSites function

Usage

getSummary(object, ...)

## S4 method for signature 'BSFDataSet'
getSummary(object)

Arguments

object	a BSFDataSet object
...	additional arguments

Value

returns the summary information storted in the summary slot after makeBindingSites was run

See Also

BSFDataSet makeBindingSites

Examples

# load data
files <- system.file("extdata", package="BindingSiteFinder")
load(list.files(files, pattern = ".rda$", full.names = TRUE))

bds <- makeBindingSites(object = bds, bsSize = 9, minWidth = 2,
minCrosslinks = 2, minClSites = 1)

getSummary(bds)

ZarnackGroup/BindingSiteFinder documentation built on May 31, 2024, 3:29 a.m.