org.opentox.interfaces
Interface IModel

All Superinterfaces:
IProne2Error
All Known Implementing Classes:
Model

public interface IModel
extends IProne2Error

Author:
chung

Method Summary
 boolean compatibleWith(weka.core.Instances testData)
          Check the assertion that a certain weka.core.Instances object is compatible with this model in terms of having proper features.
 void createModel(ModelMeta meta, java.io.OutputStream out)
          Creates the RDF representation for an OpenTox model given its name, the uri of the dataset used to train it, its target feature, the Data and a List of tuning parameters for the training algorithm.
 java.lang.String getDependentFeatureUri()
          Returns the dependent features of the model.
 java.lang.String getPredictedFeatureUri()
          Get the URI of the predicted feature of the model.
 java.util.Set<java.lang.String> getSetOfIndependentFeatures()
          The set of independent variables of the model.
 
Methods inherited from interface org.opentox.interfaces.IProne2Error
getErrorRep
 

Method Detail

compatibleWith

boolean compatibleWith(weka.core.Instances testData)
Check the assertion that a certain weka.core.Instances object is compatible with this model in terms of having proper features. In fact the set of attributes of testData must be a hyperset of the dependent attributes of the model. In plain english, the testData set should provide at least the information needed.

Parameters:
testData -
Returns:
Returns true if this Model object is compatible with the specified dataset.

createModel

void createModel(ModelMeta meta,
                 java.io.OutputStream out)
Creates the RDF representation for an OpenTox model given its name, the uri of the dataset used to train it, its target feature, the Data and a List of tuning parameters for the training algorithm. The RDF document is built according to the specification of OpenTox API (v 1.1).

Parameters:
meta - Meta-information about the model.
out - The output stream used to store the model.

getDependentFeatureUri

java.lang.String getDependentFeatureUri()
Returns the dependent features of the model.

Returns:
dependent feature URI as a String.

getPredictedFeatureUri

java.lang.String getPredictedFeatureUri()
Get the URI of the predicted feature of the model.

Returns:
URI of predicted feature.

getSetOfIndependentFeatures

java.util.Set<java.lang.String> getSetOfIndependentFeatures()
The set of independent variables of the model.

Returns:
set of URIs