report.AbstractCBS: Generates a report of the segmentation results

In HenrikBengtsson/PSCBS: Analysis of Parent-Specific DNA Copy Numbers

Generates a report of the segmentation results

Description

Generates a report of the segmentation results. Currently reports can be generated for segmentation results of class CBS and PairedPSCBS.

Usage

## S3 method for class 'AbstractCBS'
report(fit, sampleName=getSampleName(fit), studyName, ..., rspTags=NULL,
  rootPath="reports/", .filename="*", skip=TRUE, envir=new.env(), verbose=FALSE)

Arguments

fit	An AbstractCBS object.
sampleName	A character string specifying the name of the sample segmented.
studyName	A character string specifying the name of study/project.
...	Optional arguments passed to the RSP template.
rspTags	Optional character vector of tags for further specifying which RSP report to generate.
rootPath	The root directory where to write the report.
verbose	See Verbose.

Value

Returns the pathname of the generated PDF.

Author(s)

Henrik Bengtsson

See Also

For more information see AbstractCBS.

HenrikBengtsson/PSCBS documentation built on Feb. 20, 2024, 9:01 p.m.