biz.sc.mm.dm.supervised.statistical

Interface StatisticalSettings

All Superinterfaces:

java.lang.Cloneable, MiningAlgorithmSettings, MiningAlgorithmSettingsWithTransformation, PersistentObject, SupervisedAlgorithmSettings, Verifiable

All Known Subinterfaces:

ARCHSettings, BivariateAlgorithmSettings, BivariateProbitSettings, CoxSettings, DiscriminantSettings, GARCHSettings, IRLSSettings, LinearRegressionSettings, LogisticRegressionSettings, MCMCLogisticRegressionSettings, NonparametricSurvivalSettings, SurvivalAlgorithmSettings, TimeSeriesAlgorithmSettings, WeightedRegressionSettings

public interface StatisticalSettings
extends SupervisedAlgorithmSettings, MiningAlgorithmSettingsWithTransformation

Basic statistical settings (common for regression, survival, etc. methods).

Method Summary

Methods

Modifier and Type	Method and Description
double	getConfidenceLevel() Gets confidence level for interval estimation.
boolean	getExecuteInitTests() Gets initial test execution switch value.
boolean	getGroupStatistics() Gets group statistics switch value.
boolean	getInfluenceDiagnostics() Gets influence diagnostics switch value.
boolean	getIntercept() Gets intercept switch value.
OptimizationAlgorithmSettings	getOptimizationAlgorithmSettings() Gets current nonlinear optimization algorithm settings.
InfluenceDiagnostic	getOutliersCriterion() Gets the influence diagnostics criterion to identify outliers.
double	getOutliersToRemove() Gets the number of outliers to be removed from data (0 if none).
boolean	getPreselection() Gets preselection statistic switch value.
VariableSelectionSettings	getVariableSelectionSettings() Gets current variable selection settings.
void	setConfidenceLevel(double alpha) Sets confidence level for interval estimation.
void	setExecuteInitTests(boolean executeTests) Sets initial test execution switch value.
void	setGroupStatistics(boolean groupStats) Sets group statistics switch value.
void	setInfluenceDiagnostics(boolean diagnostics) Sets influence diagnostics switch value.
void	setIntercept(boolean intercept) Sets intercept switch value.
void	setOptimizationAlgorithmSettings(OptimizationAlgorithmSettings opt) Sets nonlinear optimization algorithm settings.
void	setOutliersCriterion(InfluenceDiagnostic criterion) Sets the influence diagnostics criterion to identify outliers.
void	setOutliersToRemove(double numberOfObservations) Sets the number of outliers to be removed from data (0 if none).
void	setPreselection(boolean preselection) Sets preselection statistic switch value.
void	setVariableSelectionSettings(VariableSelectionSettings vss) Sets variable selection settings.

Methods inherited from interface biz.sc.mm.dm.base.MiningAlgorithmSettingsWithTransformation

getTransformationSettings, isAutomaticDataTransformations, setAutomaticDataTransformations

Methods inherited from interface biz.sc.mm.dm.base.MiningAlgorithmSettings

clone

Methods inherited from interface biz.sc.mm.dm.PersistentObject

getDescription, getName, getObjectIdentifier, getProperties, isEditable, setDescription, setEditable, setName, setObjectIdentifier

Method Detail

setVariableSelectionSettings

void setVariableSelectionSettings(VariableSelectionSettings vss)

Sets variable selection settings.

Parameters:

vss - variable selection settings.

getVariableSelectionSettings

VariableSelectionSettings getVariableSelectionSettings()

Gets current variable selection settings.

Returns:

current variable selection settings .

setOptimizationAlgorithmSettings

void setOptimizationAlgorithmSettings(OptimizationAlgorithmSettings opt)

Sets nonlinear optimization algorithm settings.

Parameters:

opt - nonlinear optimization algorithm settings.

getOptimizationAlgorithmSettings

OptimizationAlgorithmSettings getOptimizationAlgorithmSettings()

Gets current nonlinear optimization algorithm settings.

Returns:

current nonlinear optimization algorithm settings.

getConfidenceLevel

double getConfidenceLevel()

Gets confidence level for interval estimation.

Returns:

confidence level.

setConfidenceLevel

void setConfidenceLevel(double alpha)

Sets confidence level for interval estimation.

Parameters:

alpha - confidence level.

getIntercept

boolean getIntercept()

Gets intercept switch value. Setting is ignored by survival & bivariate models.

Returns:

true if model should contain intercept, false otherwise.

setIntercept

void setIntercept(boolean intercept)

Sets intercept switch value. Setting is ignored by survival & bivariate models.

Parameters:

intercept - true if model should contain intercept, false otherwise.

getPreselection

boolean getPreselection()

Gets preselection statistic switch value. Setting is ignored by bivariate models.

Returns:

true if univariate p-value statistic should be computed, false otherwise.

setPreselection

void setPreselection(boolean preselection)

Sets preselection statistic switch value. Setting is ignored by bivariate models.

Parameters:

preselection - true if univariate p-value statistic should be computed, false otherwise.

getGroupStatistics

boolean getGroupStatistics()

Gets group statistics switch value.

Returns:

true if statistics for variable groups should be computed, false otherwise.

setGroupStatistics

void setGroupStatistics(boolean groupStats)

Sets group statistics switch value.

Parameters:

groupStats - true if statistics for variable groups should be computed, false otherwise.

getExecuteInitTests

boolean getExecuteInitTests()

Gets initial test execution switch value.

Returns:

true if initial data/task tests should be performed, false otherwise.

setExecuteInitTests

void setExecuteInitTests(boolean executeTests)

Sets initial test execution switch value.

Parameters:

executeTests - true if initial data/task tests should be performed, false otherwise.

getInfluenceDiagnostics

boolean getInfluenceDiagnostics()

Gets influence diagnostics switch value.

Returns:

true if influence diagnostics should be computed, false otherwise.

setInfluenceDiagnostics

void setInfluenceDiagnostics(boolean diagnostics)

Sets influence diagnostics switch value.

getOutliersCriterion

InfluenceDiagnostic getOutliersCriterion()

Gets the influence diagnostics criterion to identify outliers.

Returns:

the influence diagnostics criterion.

setOutliersCriterion

void setOutliersCriterion(InfluenceDiagnostic criterion)

Sets the influence diagnostics criterion to identify outliers.

Parameters:

criterion - the influence diagnostics criterion.

getOutliersToRemove

double getOutliersToRemove()

Gets the number of outliers to be removed from data (0 if none).

Returns:

the number of outlying observations.

setOutliersToRemove

void setOutliersToRemove(double numberOfObservations)

Sets the number of outliers to be removed from data (0 if none).

Parameters:

numberOfObservations - the number of outlying observations.