annotate.plate {ELISAtools} R Documentation

## S3 method to annotate ELISA plate

### Description

to write annotations for an ELISA plate as an input to guide the functions to read OD values

### Usage

annotate.plate(
sample.id,
sample.prefix,
sample.suffix,
num.sample,
num.std = 8,
byRow.sample = TRUE,
byRow.replicates = TRUE,
replicates.sample = 3,
replicates.std = 3,
rows,
columns,
std.first = TRUE
)


### Arguments

 sample.id character vector to specify the names/ids of the samples on the plate. Note, standard/calibration sample ids/names is fixed to be "s1","s2", etc, which are specified by the software and users don't need to privide. sample.prefix characters will be added to the beginning of sample names sample.suffix characters will be added to the end of sample names num.sample numeric number of samples to write num.std numeric number of standards byRow.sample boolean indicate whether to write sample names horizontally by row (TURE) or vertically by column (FALSE) byRow.replicates boolean indicate whether to write sample replicates horizontally by row (TURE) or vertically by column (FALSE) replicates.sample numeric number of replicates for each sample replicates.std numeric number of replicates for each standards rows numeric vector to specify which rows to be included in the annotation columns numeric vector to specify which columns to be included in the annotation std.first boolean to indicate whether to write standards first or the samples first.

### Details

Based on the input to quickly write the annotations for ELISA plate. The output is in a 96-well format and will be used to giude the reading of OD plates. This way only a nxm dataframe can be used. To write non-regular annotation, you have to do it mannually.

### Value

a dataframe holding the annotations for the plate.

[Package ELISAtools version 0.1.5 Index]