BAf-class: An S4 class to handle the data from Binder Arrays

Description Slots Author(s)

Description

This class is designed to store the data generated by Binder Arrays (including suspension bead arrays) technology and to facilitate the analysis of the data. It is distributed and stored in 5 main slots, .Data, sinfo, binder, assy_s, and assy_b. In order to assure the orders of samples and targets are kept same in all the variables, 'id', colnames, and rownames are checked.

Slots

.Data

matrix - row : samples, col : antibody
It contains all measured values. Its column names are reserved for target IDs. The row names are the keys to link to @sinfo assuring the order of sample is same in both.

sinfo

tbl_df - row : samples, col : variables, that contains sample information
Each row is for each sample. Each column has a type of information (e.g age) about the sample. Some description about the columns can be found in the @codebook. Two columns in this table are special.
1) A column 'id' is reserved for the unique identifiers of the samples stored in a BAf-class object. The 'id' is used to confirm the order of the samples are same as other slots. 2) One more column is reserved to indicate the batch of the samples. The name of this column is given in @batch_c.

binder

data.frame - row : binder (or antibodies / antigen), col : annotations for the binders
All information about beads or bound antibodies are stored here. Rows are in the same order of columns in @.Data.
1) Like @sinfo, A column 'id' is reserved for the unique identifiers of the binders, which have to be identical to column names of @.Data.
And one column should be assigned for binder batches. The name of the column is given in @batch_c.

batch_c

list - two elements, sinfo and binder. Each has one text to indicate the column that contains batch IDs for sample or binder in @sinfo or @binder.

assy_s

list - each element is a data.frame of a particular batch-wise property (e.g. assay_failure). The columns of the data.frame are the binder batches, while rows are samples. In every data frame, the column names should be matched to the binder batch IDs in @binder.

assy_b

list - Like @assy_s, but for binders. Each row is for each binder in @binder. The columns are for the sample batches.

codebook

list - two elements, sinfo and binder. Each contains a data frame of the codebook for @sinfo or @binder.

note

any

Author(s)

Mun-Gwan Hong <mun-gwan.hong@scilifelab.se>


Rundmus/BAf-R_package documentation built on May 18, 2020, 12:59 p.m.