report: Creates a report for pmartRseq objects

Description Usage Arguments Details Value Author(s) Examples

Description

This function generates a .docx report for a pmartRseq object

Usage

1
report(omicsData, output_file = NULL)

Arguments

omicsData

a list containing pmartRseq objects, including at least one data object (of the class 'seqData' created by as.seqData and any other pmartRseq objects to include in the report.

output_file

an optional character string specifying the name of the file to create.

Details

This function generates a .docx report for a mintR data object and a mintR results object. The report includes information about the data, groups, filtering, normalization, and statistical tests, if relevant.

Value

A .docx report of the analyses performed on the data

Author(s)

Allison Thompson

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
library(mintJansson)
data(cDNA_hiseq_data)
mycdnadata <- group_designation(omicsData = cDNA_hiseq_data, main_effects = c("treatment"), time_course=NULL)
mycdnadata_norm <- normalize_data(omicsData = mycdnadata, norm_fn = "percentile")
mycdnadata_results <- countSTAT(omicsData = mycdnadata_norm, comparisons = "all", control = NULL, test = c("dw", "eq", "el", "ef"), pval_adjust = "none", pval_thresh = 0.05)
report(omicsData = list(Norm=mycdnadata_norm, Statistics = mycdnadata_results), output_file = "cDNAdata_Report.docx")

## End(Not run)

pmartR/pmartRseq documentation built on May 25, 2019, 9:20 a.m.