generateReport: Report generation

Description Usage Arguments Details Value Examples

View source: R/functions.R

Description

Summarizes all results in the list of cellData objects, and writes out a report to file.

Usage

1
2
generateReport(lstCells, genemap = NULL, verbose = FALSE, file = NULL,
  outpath = getOption("opm.outpath"), plot = TRUE, ...)

Arguments

lstCells

a list of cellData objects

genemap

a data frame, the well-gene specification table

verbose

logical, detailed data will be provided if TRUE

file

the path of the file to generate to

outpath

a character string naming the location the figures to generate to

plot

if TRUE, plot barplot

...

arguments of the graphic device

Details

This function summarizes the information from all cellData objects, and visualizes the number of the hists if required.

Value

a data frame with annotated information of each well

Examples

1
2
3
4
5
6
data(demoCell)
genemap <- read.csv(file.path(system.file("Test", package = "OperaMate"),
"demoData", "genemap.csv"), stringsAsFactors = FALSE)
report <- generateReport(list(oneCell), genemap, verbose = FALSE,
plot = FALSE)
str(report)

OperaMate documentation built on Nov. 17, 2017, 1:55 p.m.