getFit: Compute the score of a model

In saezlab/CellNOptR: Training of boolean logic models of signalling networks using prior knowledge networks and perturbation data

Compute the score of a model

Description

This function computes the value of the objective function for a model and an associated data set, as a sum of a term that computes the fit of model to data, a term that penalises the NA values produced by the model, and a term that penalises increasing size of the model.

Usage

getFit(simResults, CNOlist, model, indexList=NULL, timePoint=c("t1", "t2"),
sizeFac=1e-04, NAFac=1, nInTot, simResultsT0=NULL)

Arguments

simResults	matrix of simulated results (the full one as output by the simulator)
CNOlist	a CNOlist to compare the simulated results with
model	a model that has already been cut to contain only the reactions in the optimal bitstring
indexList	list of indexes as produced by indexFinder. User should not use this parameter that is kept for back compatibility with previous version of the simulator written in R. The new simulator (C code) does not neccesitate the usage of the indexList parameter in this function anymore.
timePoint	"t1" or "t2" tells which time point we are looking at. If timePoint=t1 then we will compare the simResults to the results stored in CNOlist$valueSignals[[2]]. If timePoint=t1 then we will compare the simResults to the results stored in CNOlist$valueSignals[[2]]
sizeFac	weights the penalty for the size of the model, default=0.0001
NAFac	weights the penalty for the number of NAs
nInTot	the number of inputs in the model prior to cutting, used to normalised the size penalty
simResultsT0	Results of the time 0 simulator (internal usage of gaBinaryT1)

Details

BE AWARE: contrary to what is done in the Matlab version of CellNOpt, here the simulation results are computed beforehand and the model that is input into this function is a model that has already been cut i.e. that only contains the reactions present in the optimised model (i.e.should be the same model as the one that you input into the simulator). Also, the simResults matrix is the full one as output by the simulator, i.e. it contains results for all species in the model, not only the signals

Value

This function returns a single number, the value of the objective function.

Author(s)

C. Terfve

References

J. Saez-Rodriguez, L. G. Alexopoulos, J. Epperlein, R. Samaga, D. A. Lauffenburger, S. Klamt and P. K. Sorger. Discrete logic modeling as a means to link protein signaling networks with functional analysis of mammalian signal transduction, Molecular Systems Biology, 5:331, 2009.

See Also

gaBinaryT1, simulatorT1

Examples

#Here we will evaluate the fit of the full initial model, 
#without pre-processing or any optimisation

data(CNOlistToy,package="CellNOptR")
data(ToyModel,package="CellNOptR")

indicesToy<-indexFinder(CNOlistToy,ToyModel,verbose=FALSE)
ToyFields4Sim<-prep4sim(ToyModel)
simResults<-simulatorT1(
	CNOlist=CNOlistToy,
	model=ToyModel,
	simList=ToyFields4Sim,
	indexList=indicesToy)
simResults = simResults[, indicesToy$signals]
Score<-getFit(
	simResults=simResults,
	CNOlist=CNOlistToy,
	model=ToyModel,
	timePoint="t1", 
    nInTot=length(which(ToyModel$interMat == -1))
    )

saezlab/CellNOptR documentation built on April 16, 2024, 5:21 a.m.