processingStepsTable: Create a table of all workflow steps for reporting

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

Create a table of all workflow steps for reporting

Description

Function that creates a printable table with all steps and numbers for each of the workflow steps that were carried out.

Usage

processingStepsTable(object, option = c("reduced", "full", "extended"))

Arguments

object	a BSFDataSet object with stored ranges
option	character; how detailed the table should be

Details

If option is set to 'reduced', only the most necessary information are collected. Option 'full' contains a full list of all options and parameters that were set in any of the workflow functions. Option 'extended' contains extra information about the binding site merging step.

Value

a kableExtra table

See Also

BSFind

Examples

# load data
files <- system.file("extdata", package="BindingSiteFinder")
load(list.files(files, pattern = ".rda$", full.names = TRUE))
# apply 5% filter
bds = pureClipGlobalFilter(object = bds, cutoff = 0.05)
processingStepsTable(bds)

ZarnackGroup/BindingSiteFinder documentation built on May 2, 2024, 12:38 a.m.