apply_template: Annotate Plate Read Data with Metadata from a Template

Description Usage Arguments Details Value Examples

View source: R/apply_template.R

Description

apply_template combines plate read data with metadata from a template, producing a data frame that contains both the read values along with additional information such as strain, medium, drug concentration, etc.

Usage

1
2
3
4
5
6
7
apply_template(plate, template, ...)

## S3 method for class 'data.frame'
apply_template(plate, template, ...)

## S3 method for class 'softermax.plate'
apply_template(plate, template, ...)

Arguments

plate

Either a softermax.plate object (produced by read_softmax_xml), or a data frame.

template

A data frame containing information about wells in a plate. See read_softmax6_template, or create a data frame where each row contains information about a well (in the Well column), and other columns specify the value of an experimental variable (e.g., drug concentration).

...

Additional arguments passed to merge

Details

By default, the resulting data frame will contain data only for the wells specified in the template. To include all wells in the plate data (but not necessarily also in the template), use the argument all.x = TRUE. To include all wells specified in both, use the argument all = TRUE.

Value

A data frame

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
library(softermax)

d1 <- read_softmax_xml("myfile.xml")
p1 <- d1$experiments[["Experiment#1"]]$plates[["Plate#1"]]
template <- read_softmax_template("plate_template.txt")

annotated <- apply_template(p1, template)

## End(Not run)

briandconnelly/softermax documentation built on Sept. 23, 2017, 8:09 p.m.