annotateFlowSet: Annotate a flowSet with experimental metadata

Description Usage Arguments Value Examples

View source: R/generalFunctions.R

Description

Add annotations to a flowSets phenoData and plate numbers, strain names, and treatment also set T0

Usage

1
annotateFlowSet(yourFlowSet, annotation_df, mergeBy = "name")

Arguments

yourFlowSet

a flowSet with sampleNames of the format 'plate#_Well', we typically use the following code chunk to read data from individual plates as exported from BD Accuri C6 software.

annotation_df

A data frame with columns 'well', 'strain', 'treatment', containing all of the wells in the flowset labeled with the strain and treatment in that well.

mergeBy

the unique identifier column

Value

An annotated flowSet

Examples

1
2
3
4
5
dat <- read.flowSet(path = system.file("extdata", "ss_example",
package = "flowTime"), alter.names = TRUE)
annotation <- read.csv(system.file("extdata", "ss_example.csv", package =
"flowTime"))
annotateFlowSet(dat, annotation, mergeBy = "name")

flowTime documentation built on Nov. 8, 2020, 8:13 p.m.