report: Produce an html report of a segmentation

Description Usage Arguments Details Value

Description

Produce an html report of a segmentation

Usage

1
2
report(segments, model, outdir = ".", prefix = "", colors = NULL,
  labels = NULL, annots = list(), rdata = NULL, autoColors = NULL)

Arguments

segments

GRanges or GRangesList object containing the segmentation. If GRanges, the names slot must be a number from 1 to the maximum number of states. Same is true for the unlisted data in a GRangesList. If a GRangesList, the paths to of each bed file will depend on the names given by names(segments).

model

A list with the complete set of the parameters that describe the HMM, such as that returned by the segment function.

outdir

Output directory where the report will be created.

prefix

Prefix prepended to all output files.

colors

A character vector assigning one color per state. each color must be a valid R color.

labels

A character vector assigning one name per state

annots

Named list where each item is a GRanges object to be compared with the segmentation.

rdata

R objects that will be saved as Rdata archives and will be part of the report.

autoColors

a list with two fields that controls how the colors are automatically assigned to each state. The value NULL disables automatic coloring.

Details

A web page will be created with plots linked to tables in text format.

Value

The path to the newly created webpage


lamortenera/epicseg documentation built on May 20, 2019, 7:34 p.m.