report: Produce an HTML report of the mAP-KL analysis

Description Usage Arguments Details Value Author(s) Examples

View source: R/report.R

Description

This function gathers the results of several analysis sessions ( feature selection, classification, annotation and network) and produces a report in HTML format.

Usage

1
    report(mAPKLObj, ClassifyObj, AnnotObj=NULL, netObj=NULL, file)

Arguments

mAPKLObj

An object of mAPKL class.

ClassifyObj

An object of mAPKL class.

AnnotObj

An object of Annot class.

netObj

An object of NetAttr class.

file

The full path and the name of the produced report

Details

It presents the data samples with their phenotype labels, the exemplars with their statistical scores( adj.p-value, p-value and fc), and network characteristics (like weighted local degree,closeness,betweenness, transitivity) if such a network analysis has been performed. In addition, the report presents the classification performance achieved by those exemplars (either cross-validation or hold-out), and finally several annoation information (symbol, entrez id, ensemble id, and their chromosomal location) if an annotation analysis has been carried out.

Value

Upon successful completion an HTML report is saved in the working directory.

Author(s)

Argiris Sakellariou

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## When a network attributes object is present
## Not run: report(out,class.pred,class.metrics,netObj=net.attr,
"C:/.../.../mAPKLreport.html")#Define a local path to store your report
## End(Not run)

## When an annotation object is present
## Not run: report(out,class.pred,class.metrics,gene.info,
"C:/.../.../mAPKLreport.html")#Define a local path to store your report
## End(Not run)

## Without annotation and network attributes objects
## Not run: report(out,class.pred,class.metrics,
file="C:/.../.../mAPKLreport.html")#Define a local path to store your report
## End(Not run)

mAPKL documentation built on Nov. 8, 2020, 4:57 p.m.