InputDescriptor Members

These members are related to Input Descriptor.

Functions

Name Description
ApplyCaseWeight Set the attached Spreadsheet's Case Weight to a copy of this object's Case Weight.
ApplySelectionConditions Set the attached Spreadsheet's Selection Conditions to a copy of this object's Selection Conditions.
ClearSelections Clears all variable and code selections in this InputDescriptor.
ClearSpecialCode -
Clone Returns a clone of the current input data input descriptor; if pSS is an input spreadsheet, attaches that data source to the clone. Return value: InputDescriptor.
CopySettings Overwrites this object's variable selections, codes, etc with those of pInpDesc.
ExportXML Export selections and settings in XML format. Return value: String.
ImportXML Import selections and settings in XML format.
Map Replaces this object's DataSource Spreadsheet with a MappedSubset containing all currently selected variables. Future uses of DataSource property return this MappedSubset object.
RestoreCaseWeight Restore the attached Spreadsheet's Case Weights to their value before the call to ApplyCaseWeight.
RestoreSelectionConditions Restore the attached Spreadsheet's Selection Conditions to their value before the call to ApplySelectionConditions.
Unmap Undoes the call to Map, releasing the MappedSubset. Future uses of DataSource property return the real Spreadsheet object.
UpdateVarSelAfterDeleteVariables Updates the variable selections when variables are deleted from the data source.

Properties

Name Description
CaseWeight Case weight object; 0 means undefined. Return value: CaseWeight. This property is read only.
CategoricalDependentVariables List of categorical dependent variables; for classification problems. Return/assignment value: Integer().
CategoricalDependentVariablesString String representation of list of categorical dependent variables; for classification problems. Return value: String. This property is read only.
CategoricalPredictors List of categorical predictor variables. Return/assignment value: Integer().
CategoricalPredictorsString String representation of list of categorical predictor variables. Return value: String. This property is read only.
CategoricalVars List all categorical variables in use, including learning-testing indicator and censoring indicator. Return value: Integer(). This property is read only.
CensoringVariable Censoring indicator variable; used in survival analysis methods applied to data with censored observations. Return/assignment value: Integer.
ContinuousDependentVariables List of continuous dependent variables for regression problems; or variables for clustering and time-series problems. Return/assignment value: Integer().
ContinuousDependentVariablesString String representation of list of continuous dependent variables for regression problems; or variables for clustering and time-series problems. Return value: String. This property is read only.
ContinuousPredictors List of continuous predictor variables. Return/assignment value: Integer().
ContinuousPredictorsString String representation of list of continuous predictor variables. Return value: String. This property is read only.
CountsVariable Variable containing counts (used in analyses that can accept count variables). Return/assignment value: Integer.
DataSource Data source for data miner project. Return/assignment value: InputSpreadSheet.
DependentVariableCodes List of actual integer codes used in each categorical dependent variable to indicate group or class membership of observations. Return/assignment value: Integer().
DependentVariableCodesString String representation of list of actual integer codes used in each categorical dependent variable to indicate group or class membership of observations. Return value: String. This property is read only.
DependentVariableCodesStringAll Returns/sets string representation of codes for all categorical dependent variables in form such as 'TESTING|TRAINING'. Return/assignment value: String.
IDVariable Get/Set the ID Variable. Return/assignment value: String.
Id Item Identifier. Return value: Long. This property is read only.
InDBAnalyticsInfo Return value: InDBAnalyticsInfo. This property is read only.
IsDatabaseConnection Flag to indicate whether the current input descriptor pertains to a (remote) data source, to be processed in place. Return value: Boolean. This property is read only.
IsDeployment Deployment flag; if true, then previously estimated parameters or trained neural networks will be applied to the (new) data (and the parameters will not be estimated again, and neural networks will not be retrained. Return/assignment value: Boolean.
IsMappedSubset Returns True if the attached DataSource is a MappedSubset. Return value: Boolean. This property is read only.
LearningTestingVariable Learning (training) vs. testing (cross-validation) indicator variable; used in analysis methods that may use crossvalidation samples to estimate or refine solutions. Return/assignment value: Integer.
Name Item name. Return/assignment value: String.
NumberOfCategoricalDependentVariables Number of categorical dependent variables; for classification problems. Return value: Integer. This property is read only.
NumberOfCategoricalPredictors Number of categorical predictor variables. Return value: Integer. This property is read only.
NumberOfContinuousDependentVariables Number of continuous dependent variables for regression problems; or variables for clustering and time-series problems. Return value: Integer. This property is read only.
NumberOfContinuousPredictors Number of continuous predictor variables. Return value: Integer. This property is read only.
NumberOfDependentVariableCodes Number of codes (categories or classes) in each categorical predictor variable. Return value: Integer. This property is read only.
NumberOfPredictorCodes Number of codes (categories or classes) in each categorical predictor variable. Return value: Integer. This property is read only.
NumberOfSupplementaryDataCodes Number of codes (categories or classes) in each categorical predictor variable. Return value: Integer. This property is read only.
NumberOfSupplementaryDataVariables Number of supplementary data variables. Return value: Integer. This property is read only.
NumberOfVariablesInUse Return a count of total number of variables in use. Return value: Integer. This property is read only.
PredictorCodes List of actual integer codes used in each categorical predictor variable to indicate group or class membership of observations. Return/assignment value: Integer().
PredictorCodesString String representation of list of actual integer codes used in each categorical predictor variable to indicate group or class membership of observations. Return value: String. This property is read only.
PredictorCodesStringAll Returns/sets string representation of codes for all categorical predictors in form such as 'TESTING|TRAINING'. Return/assignment value: String.
SelectionCondition Case selection conditions. Return value: SelectionCondition. This property is read only.
SourceId Item Source Identifier. Return/assignment value: Long().
SpecialCode Code to indicate censoring (censored or complete responses), or learning vs. training samples; pass the type of code you want to set/retrieve as an argument. Return/assignment value: Integer.
SpecialCodeDefined If true, then the respective type of code is defined (selected); otherwise the respective code is uninitialized. Return value: Boolean. This property is read only.
SpecialCodeString Code to indicate censoring (censored or complete responses), or learning vs. training samples; pass the type of code you want to set/retrieve as an argument. Return value: String. This property is read only.
SupplementaryData Supplementary data arrays; can be used to pass auxiliary information between nodes; up to 10 arrays can be specified (idx indexed from 1 through 10. Return/assignment value: Integer().
SupplementaryDataCodes Supplementary data codes for Link Analysis. Return/assignment value: Long().
SupplementaryDataCodesString Supplementary data code string for Link Analysis. Return value: String. This property is read only.
SupplementaryDataString Supplementary data arrays; can be used to pass auxiliary information between nodes; up to 10 arrays can be specified (idx indexed from 1 through 10. Return value: String. This property is read only.
VariablesInUse List all variables in use. Return value: Integer(). This property is read only.