exportToExcel: Export the algorithms results to an Excel file

Description Usage Arguments Value Examples

View source: R/ddPCRclust.R

Description

A convinience function that takes the results of the droplClust algorithm and exports them to an Excel file.

Usage

1
exportToExcel(data, directory, annotations, raw = FALSE)

Arguments

data

The result of the ddPCRclust algorithm

directory

The parent directory where the files should saved. A new folder with the experiment name will be created (see below).

annotations

Some basic metadata about the ddPCR reaction. If you provided ddPCRclust a template, this paramater can be filled with the corresponding field in the result. Otherwise, you have to provide a character vector containing a name and the the color channels, e.g. c(Name='ddPCR_01-04-2017', Ch1='HEX', Ch2='FAM')

raw

Boolean which determines if the annotated raw data should be exported along with the final counts. Basically, a third column will be added to the original data, which contains the cluster number to which this point was assigned to. Useful for example to visualize the clustering later on. (Warning: this can take a while!)

Value

None

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# Read files
exampleFiles <- list.files(paste0(find.package('ddPCRclust'), '/extdata'), full.names = TRUE)
files <- readFiles(exampleFiles[3])
# To read all example files uncomment the following line
# files <- readFiles(exampleFiles[1:8])

# Read template
template <- readTemplate(exampleFiles[9])

# Run ddPCRclust
result <- ddPCRclust(files, template)

# Export the results
dir.create('./Results')
exportToExcel(data = result, directory = './Results/', annotations = result$annotations)

ddPCRclust documentation built on Nov. 8, 2020, 6:06 p.m.