design {sampleInfo} R Documentation

Create new analysis design sample info via formula

Description

Usage

design(sampleinfo,
    ... = NULL);

Arguments

sampleinfo

the sample information data, which can be a vector of the @T:SMRUCC.genomics.GCModeller.Workbench.ExperimentDesigner.SampleInfo

designs

a tuple list of the experiment design formula: the slot key of the list is the label of the new sample group and the slot value is a formula expression that describes the merge of the original sample groups, example as list(A = B + C + D) means that the sample groups B, C and D will be merged into a new sample group A. [as list]

env

[as Environment]

Details

the sample information data(the ID, sample_name, color, shape, batch and injectionOrder property) of the merged samples will be kept as is, only the sample_info group label will be replaced with the new group label.

the design formula expression is a lazy expression, so that the sample group label in the formula is not required to be a R# symbol.

Authors

phenotype_kit

Value

a new vector of the SampleInfo object: the sample groups that are described in the given design formula will be replaced with the new generated sample groups, and the other sample groups that are not referenced in the design formula will be kept as is;

this function returns a R# error message object if the input data can not be cast to a collection of the sample information data, or the given design formula is invalid.

clr value class

Examples

 imports "sampleInfo" from "phenotype_kit";
 
 # merge the sample groups of "B", "C" and "D" into 
 # a new sample group "A"
 let samples = design(samples, list(A = B + C + D));
[Package sampleInfo version 1.0.0.0 Index]