readTemplate: Read a template file from disk

Description Usage Arguments Value Examples

View source: R/ddPCRclust.R

Description

This function reads a template file for ddPCRclust from disk and returns a run template and annotations. Please refer to the vignette for information on how this file need to be formatted.

Usage

1
readTemplate(template)

Arguments

template

A csv file containing information about the individual ddPCR runs. An example template is provided with this package. For more information, please check the vignette or the repository on github.

Value

annotations

The metatdata provided in the header of the template. It contains four fields:
Name The name given to this ddPCR experiment
Ch1 Color channel 1 (usually HEX)
Ch2 Color channel 2 (usually FAM)
descriptions Additional descriptions about this ddPCR experiment (e.g. date, exprimentor, etc.)

template

A parsed dataframe containing the template.

Examples

1
2
3
# Read template
exampleFiles <- list.files(paste0(find.package('ddPCRclust'), '/extdata'), full.names = TRUE)
template <- readTemplate(exampleFiles[9])

bgbrink/dropClust documentation built on Nov. 7, 2019, 12:18 p.m.