Xplain.Db.PredictiveModel
- Xplain.Db.PredictiveModel()
This class represents a Xplain Predictive Model. Provides methods to get data from the predictive model.
findVariable
- findVariable(name)
Finds a variable within this predictive model.
- Parameters
name (string) – The name of the variable to find.
- Returns
{object} A variable as object or
false
findVariableGroup
- findVariableGroup(name)
Finds a variable group within this predictive model.
- Parameters
name (string) – The name of the variable group to find.
- Returns
{object} A variable group as object or
false
getConfiguration
- getConfiguration()
Returns the configuration of this predictive model.
- Returns
{object} The configuration as raw object.
getGraph
- getGraph()
returns the graph which belong to this predictive model (if this pred. model does have a graph).
- Returns
{array} the graph belonging to this predictive model or
false
getRawData
- getRawData()
Returns this predictive model’s data as it has been returned by the backend, i.e. “raw”.
- Returns
{Object} This predictive model’s data as it has been returned by the backend
getSession
- getSession()
Returns the session to which this predective model belongs.
- Returns
{Xplain.Db.Session} the session to which this predictive model belongs.
getTargetName
- getTargetName()
Returns the target name of this predictive model.
- Returns
{string} the target name of this predictive model
getVariableGroups
- getVariableGroups()
returns an array of all variable groups which belong to this predictive model.
- Returns
{array} array of all variable groups belonging to this predictive model
getVariables
- getVariables()
returns an array of all variables which belong to this predictive model.
- Returns
{array} array of all variables belonging to this predictive model