caFlowQ (version 0.5.0)

runExampleReport: Expose flowQ functionality as web services

Description

The runExampleReport function generates a flowQ report from the internal GvHD data.

The runCustomReport function generates a report from data that has been uploaded on the server by the client.

Usage

runExampleReport(n = 5)
runCustomReport(indir)

Arguments

n

The number of samples in the GvHD data set to be used for generating the report.

indir

An object of class FileReferences giving the file path to the directory on the sever where the FCS and annotation files have been uploaded by the client.

Value

• An object of class caFlowQUrl giving the URL where the client is supposed to download the zipped flowQ report.

Details

The runExampleReport function is meant to be a test function for the general setup of the web service. No file upload is necessary.

The runExampleReport function is closer to the final work flow. A set of FCS files and the nexessary annotation information have to be uploaded by the client, and the function will first read this data in and then produce the report.

Later we will add customization to the reports but the details haven't been decided yet.

Examples

td <- tempdir()
res <- runExampleReport(n=5)


file.copy(system.file("extdata/fcsfiles.tar.gz", package="caFlowQ"), td)
owd <- setwd(td)
system("tar -xzvf fcsfiles.tar.gz")
setwd(owd)

inFiles <- paste("file://",
                  list.files(file.path(td, "fcsfiles"), full=TRUE),
                  sep="")
indir <- FileReferences(inFiles)

res <- runCustomReport(indir=indir)