training_set {GEARS} R Documentation

Set the training sample set

Description

Usage

training_set(gears, x, controls, perturbed);

Arguments

gears

a GEARS model object that is created by the GEARS::new. [as GEARS]

x

[as Matrix]

controls

perturbed

a collection of the SampleInfo sample information data of the perturbed samples: the ID property of the sample data should be matched with the sample column of the given expression matrix, the perturbed gene id set of each sample is stored as a json string array in the metadata property via the perturbed_genes key, and the intervention mode of each sample could be stored in the metadata property via the intervention_mode key(the value should be one of Knockout, Knockdown, Overexpression or Custom

env

[as Environment]

Details

the wildtype baseline(the mean and the standard deviation of each gene) of the GEARS model will be recomputed from the given control sample columns, so that this api should be called before the train api.

Authors

biosystem

Value

the input GEARS model object that the training sample set has been set;

this function returns a R# error message object if the given perturbed sample data can not be cast to a collection of the SampleInfo data.

clr value class

Examples


[Package GEARS version 1.0.0.0 Index]