Decision Tree Action Set: Syntax
Provides actions for modeling and scoring with decision trees, forests, and gradient boosting
forestScore Action
Scores a table using a forest model.
Summary: Input and Output Tables
If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametermodelTable |
— |
specifies the table containing the model. |
|
required parametertable |
— |
specifies the settings for an input table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the table to store the scored results in. When not specified, the action scores the data set and computes only the mis-classification rate for classifications and mean squared error for regressions. |
Parameter Descriptions
applyRowOrder=TRUE | FALSE
Specifies that you wish the action use a prespecified row ordering. This requires using the orderby and groupby parameters on a preliminary table.partition action call.
| Alias | reproducibleRowOrder |
|---|---|
| Default | FALSE |
assess=TRUE | FALSE
when set to True, predicted probabilities are added to the result table for the event levels. You can use these predicted probabilities with the assess action.
| Default | FALSE |
|---|
assessOneRow=TRUE | FALSE
when set to True, predicted probabilities are added to the result table for the event levels. All event probabilities are included as separate columns and are named with the prefix _DT_P_. You can use these predicted probabilities with the assess action.
| Default | FALSE |
|---|
casOut={casouttable}
specifies the table to store the scored results in. When not specified, the action scores the data set and computes only the mis-classification rate for classifications and mean squared error for regressions.
For more information about specifying the casOut parameter, see the common casouttable parameter.
copyVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the variables to transfer from the input table to the output table.
| Alias | copyVar |
|---|
encodeName=TRUE | FALSE
specifies whether to encode the variable names such as predicted probabilities of a binary or nominal target in the generated casout table. The predicted probabilities are named with the prefix P_ instead of _DT_P_.
| Default | FALSE |
|---|
impute=TRUE | FALSE
specifies how to handle observations with non-missing value for the target variable. When true, the observed values are assumed to be known without error and are used as the predicted values.
| Default | FALSE |
|---|
includeMissing=TRUE | FALSE
by default, observations with missing values are included. When set to False, observations with missing values for the variables used in the tree model are ignored when scoring.
| Default | TRUE |
|---|
isolation=TRUE | FALSE
| Default | FALSE |
|---|
modelId="string"
specifies the model ID variable name to use when generating the scored table. By default, the variable name is _DT_PredName_ for classifications, _DT_PredLowerbd_ and _DT_PredUpperbd_ for a binned target, and _DT_PredMean_ for regressions.
* modelTable={castable}
specifies the table containing the model.
| Long form | modelTable={name="table-name"} |
|---|---|
| Shortcut form | modelTable="table-name" |
| Alias | model |
|---|
The castable value can be one or more of the following:
caslib="string"
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the input table.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
|---|
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
whereTable={groupbytable}
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
casLib="string"
specifies the caslib for the filter table. By default, the active caslib is used.
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the filter table.
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the data from the filter table.
nTree=integer
specifies the number of trees to use while scoring.
| Alias | nTrees |
|---|---|
| Default | MACINT |
| Minimum value | 1 |
quantiles={double-1 <, double-2, ...>}
specifies a list of quantile values to compute for quantile regression forest predictions.
rbaImp=TRUE | FALSE
specifies variable importance using the random branch assignments (RBA) method.
| Default | FALSE |
|---|
seed=double
specifies the seed for the random number generator. By default, the random number stream is based on the computer clock. Negative values also result in random number streams based on the computer clock. If you want a reproducible random number sequence between runs, specify a value that is greater than zero.
| Default | 0.0 |
|---|---|
| Range | 0.0–MACINT |
* table={castable}
specifies the settings for an input table.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="table-name" |
The castable value can be one or more of the following:
caslib="string"
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the input table.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
|---|
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
whereTable={groupbytable}
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
casLib="string"
specifies the caslib for the filter table. By default, the active caslib is used.
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the filter table.
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the data from the filter table.
target="variable-name"
specifies the target variable when scoring a data set. If the target variable name in the tree model is the same in the scored table, then this option is not required.
treeError=TRUE | FALSE
when set to True, the error is computed for each tree.
| Default | FALSE |
|---|
treeVotes=TRUE | FALSE
requests that the scored table generated by scoring forest is enhanced with information about the votes of the individual trees.
| Default | FALSE |
|---|
varIntImp=integer
requests variable interaction importance and specifies the maximum degree of interaction.
| Default | 1 |
|---|---|
| Range | 0–3 |
forestScore Action
Scores a table using a forest model.
Summary: Input and Output Tables
If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametermodelTable |
— |
specifies the table containing the model. |
|
required parametertable |
— |
specifies the settings for an input table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the table to store the scored results in. When not specified, the action scores the data set and computes only the mis-classification rate for classifications and mean squared error for regressions. |
Parameter Descriptions
applyRowOrder=true | false
Specifies that you wish the action use a prespecified row ordering. This requires using the orderby and groupby parameters on a preliminary table.partition action call.
| Alias | reproducibleRowOrder |
|---|---|
| Default | false |
assess=true | false
when set to True, predicted probabilities are added to the result table for the event levels. You can use these predicted probabilities with the assess action.
| Default | false |
|---|
assessOneRow=true | false
when set to True, predicted probabilities are added to the result table for the event levels. All event probabilities are included as separate columns and are named with the prefix _DT_P_. You can use these predicted probabilities with the assess action.
| Default | false |
|---|
casOut={casouttable}
specifies the table to store the scored results in. When not specified, the action scores the data set and computes only the mis-classification rate for classifications and mean squared error for regressions.
For more information about specifying the casOut parameter, see the common casouttable parameter.
copyVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the variables to transfer from the input table to the output table.
| Alias | copyVar |
|---|
encodeName=true | false
specifies whether to encode the variable names such as predicted probabilities of a binary or nominal target in the generated casout table. The predicted probabilities are named with the prefix P_ instead of _DT_P_.
| Default | false |
|---|
impute=true | false
specifies how to handle observations with non-missing value for the target variable. When true, the observed values are assumed to be known without error and are used as the predicted values.
| Default | false |
|---|
includeMissing=true | false
by default, observations with missing values are included. When set to False, observations with missing values for the variables used in the tree model are ignored when scoring.
| Default | true |
|---|
isolation=true | false
| Default | false |
|---|
modelId="string"
specifies the model ID variable name to use when generating the scored table. By default, the variable name is _DT_PredName_ for classifications, _DT_PredLowerbd_ and _DT_PredUpperbd_ for a binned target, and _DT_PredMean_ for regressions.
* modelTable={castable}
specifies the table containing the model.
| Long form | modelTable={name="table-name"} |
|---|---|
| Shortcut form | modelTable="table-name" |
| Alias | model |
|---|
The castable value can be one or more of the following:
caslib="string"
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=true | false
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | false |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the input table.
singlePass=true | false
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
|---|
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
whereTable={groupbytable}
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
casLib="string"
specifies the caslib for the filter table. By default, the active caslib is used.
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the filter table.
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the data from the filter table.
nTree=integer
specifies the number of trees to use while scoring.
| Alias | nTrees |
|---|---|
| Default | MACINT |
| Minimum value | 1 |
quantiles={double-1 <, double-2, ...>}
specifies a list of quantile values to compute for quantile regression forest predictions.
rbaImp=true | false
specifies variable importance using the random branch assignments (RBA) method.
| Default | false |
|---|
seed=double
specifies the seed for the random number generator. By default, the random number stream is based on the computer clock. Negative values also result in random number streams based on the computer clock. If you want a reproducible random number sequence between runs, specify a value that is greater than zero.
| Default | 0.0 |
|---|---|
| Range | 0.0–MACINT |
* table={castable}
specifies the settings for an input table.
| Long form | table={name="table-name"} |
|---|---|
| Shortcut form | table="table-name" |
The castable value can be one or more of the following:
caslib="string"
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=true | false
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | false |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the input table.
singlePass=true | false
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
|---|
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
whereTable={groupbytable}
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
casLib="string"
specifies the caslib for the filter table. By default, the active caslib is used.
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the filter table.
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the data from the filter table.
target="variable-name"
specifies the target variable when scoring a data set. If the target variable name in the tree model is the same in the scored table, then this option is not required.
treeError=true | false
when set to True, the error is computed for each tree.
| Default | false |
|---|
treeVotes=true | false
requests that the scored table generated by scoring forest is enhanced with information about the votes of the individual trees.
| Default | false |
|---|
varIntImp=integer
requests variable interaction importance and specifies the maximum degree of interaction.
| Default | 1 |
|---|---|
| Range | 0–3 |
forestScore Action
Scores a table using a forest model.
Summary: Input and Output Tables
If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametermodelTable |
— |
specifies the table containing the model. |
|
required parametertable |
— |
specifies the settings for an input table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the table to store the scored results in. When not specified, the action scores the data set and computes only the mis-classification rate for classifications and mean squared error for regressions. |
Parameter Descriptions
applyRowOrder=True | False
Specifies that you wish the action use a prespecified row ordering. This requires using the orderby and groupby parameters on a preliminary table.partition action call.
| Alias | reproducibleRowOrder |
|---|---|
| Default | False |
assess=True | False
when set to True, predicted probabilities are added to the result table for the event levels. You can use these predicted probabilities with the assess action.
| Default | False |
|---|
assessOneRow=True | False
when set to True, predicted probabilities are added to the result table for the event levels. All event probabilities are included as separate columns and are named with the prefix _DT_P_. You can use these predicted probabilities with the assess action.
| Default | False |
|---|
casOut={casouttable}
specifies the table to store the scored results in. When not specified, the action scores the data set and computes only the mis-classification rate for classifications and mean squared error for regressions.
For more information about specifying the casOut parameter, see the common casouttable parameter.
copyVars=["variable-name-1" <, "variable-name-2", ...>]
specifies the variables to transfer from the input table to the output table.
| Alias | copyVar |
|---|
encodeName=True | False
specifies whether to encode the variable names such as predicted probabilities of a binary or nominal target in the generated casout table. The predicted probabilities are named with the prefix P_ instead of _DT_P_.
| Default | False |
|---|
impute=True | False
specifies how to handle observations with non-missing value for the target variable. When true, the observed values are assumed to be known without error and are used as the predicted values.
| Default | False |
|---|
includeMissing=True | False
by default, observations with missing values are included. When set to False, observations with missing values for the variables used in the tree model are ignored when scoring.
| Default | True |
|---|
isolation=True | False
| Default | False |
|---|
modelId="string"
specifies the model ID variable name to use when generating the scored table. By default, the variable name is _DT_PredName_ for classifications, _DT_PredLowerbd_ and _DT_PredUpperbd_ for a binned target, and _DT_PredMean_ for regressions.
* modelTable={castable}
specifies the table containing the model.
| Long form | modelTable={"name":"table-name"} |
|---|---|
| Shortcut form | modelTable="table-name" |
| Alias | model |
|---|
The castable value can be one or more of the following:
"caslib":"string"
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
"computedOnDemand":True | False
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | False |
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of the format field plus the length of the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"computedVarsProgram":"string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* "name":"table-name"
specifies the name of the input table.
"singlePass":True | False
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
|---|
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of the format field plus the length of the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"where":"where-expression"
specifies an expression for subsetting the input data.
"whereTable":{groupbytable}
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
"casLib":"string"
specifies the caslib for the filter table. By default, the active caslib is used.
"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* "name":"table-name"
specifies the name of the filter table.
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of the format field plus the length of the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"where":"where-expression"
specifies an expression for subsetting the data from the filter table.
nTree=integer
specifies the number of trees to use while scoring.
| Alias | nTrees |
|---|---|
| Default | MACINT |
| Minimum value | 1 |
quantiles=[double-1 <, double-2, ...>]
specifies a list of quantile values to compute for quantile regression forest predictions.
rbaImp=True | False
specifies variable importance using the random branch assignments (RBA) method.
| Default | False |
|---|
seed=double
specifies the seed for the random number generator. By default, the random number stream is based on the computer clock. Negative values also result in random number streams based on the computer clock. If you want a reproducible random number sequence between runs, specify a value that is greater than zero.
| Default | 0.0 |
|---|---|
| Range | 0.0–MACINT |
* table={castable}
specifies the settings for an input table.
| Long form | table={"name":"table-name"} |
|---|---|
| Shortcut form | table="table-name" |
The castable value can be one or more of the following:
"caslib":"string"
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
"computedOnDemand":True | False
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | False |
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of the format field plus the length of the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"computedVarsProgram":"string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* "name":"table-name"
specifies the name of the input table.
"singlePass":True | False
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
|---|
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of the format field plus the length of the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"where":"where-expression"
specifies an expression for subsetting the input data.
"whereTable":{groupbytable}
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
"casLib":"string"
specifies the caslib for the filter table. By default, the active caslib is used.
"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* "name":"table-name"
specifies the name of the filter table.
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of the format field plus the length of the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"where":"where-expression"
specifies an expression for subsetting the data from the filter table.
target="variable-name"
specifies the target variable when scoring a data set. If the target variable name in the tree model is the same in the scored table, then this option is not required.
treeError=True | False
when set to True, the error is computed for each tree.
| Default | False |
|---|
treeVotes=True | False
requests that the scored table generated by scoring forest is enhanced with information about the votes of the individual trees.
| Default | False |
|---|
varIntImp=integer
requests variable interaction importance and specifies the maximum degree of interaction.
| Default | 1 |
|---|---|
| Range | 0–3 |
forestScore Action
Scores a table using a forest model.
Summary: Input and Output Tables
If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
required parametermodelTable |
— |
specifies the table containing the model. |
|
required parametertable |
— |
specifies the settings for an input table. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the table to store the scored results in. When not specified, the action scores the data set and computes only the mis-classification rate for classifications and mean squared error for regressions. |
Parameter Descriptions
applyRowOrder=TRUE | FALSE
Specifies that you wish the action use a prespecified row ordering. This requires using the orderby and groupby parameters on a preliminary table.partition action call.
| Alias | reproducibleRowOrder |
|---|---|
| Default | FALSE |
assess=TRUE | FALSE
when set to True, predicted probabilities are added to the result table for the event levels. You can use these predicted probabilities with the assess action.
| Default | FALSE |
|---|
assessOneRow=TRUE | FALSE
when set to True, predicted probabilities are added to the result table for the event levels. All event probabilities are included as separate columns and are named with the prefix _DT_P_. You can use these predicted probabilities with the assess action.
| Default | FALSE |
|---|
casOut=list(casouttable)
specifies the table to store the scored results in. When not specified, the action scores the data set and computes only the mis-classification rate for classifications and mean squared error for regressions.
For more information about specifying the casOut parameter, see the common casouttable parameter.
copyVars=list("variable-name-1" <, "variable-name-2", ...>)
specifies the variables to transfer from the input table to the output table.
| Alias | copyVar |
|---|
encodeName=TRUE | FALSE
specifies whether to encode the variable names such as predicted probabilities of a binary or nominal target in the generated casout table. The predicted probabilities are named with the prefix P_ instead of _DT_P_.
| Default | FALSE |
|---|
impute=TRUE | FALSE
specifies how to handle observations with non-missing value for the target variable. When true, the observed values are assumed to be known without error and are used as the predicted values.
| Default | FALSE |
|---|
includeMissing=TRUE | FALSE
by default, observations with missing values are included. When set to False, observations with missing values for the variables used in the tree model are ignored when scoring.
| Default | TRUE |
|---|
isolation=TRUE | FALSE
| Default | FALSE |
|---|
modelId="string"
specifies the model ID variable name to use when generating the scored table. By default, the variable name is _DT_PredName_ for classifications, _DT_PredLowerbd_ and _DT_PredUpperbd_ for a binned target, and _DT_PredMean_ for regressions.
* modelTable=list(castable)
specifies the table containing the model.
| Long form | modelTable=list(name="table-name") |
|---|---|
| Shortcut form | modelTable="table-name" |
| Alias | model |
|---|
The castable value can be one or more of the following:
caslib="string"
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the input table.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
|---|
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
whereTable=list(groupbytable)
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
casLib="string"
specifies the caslib for the filter table. By default, the active caslib is used.
dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the filter table.
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the data from the filter table.
nTree=integer
specifies the number of trees to use while scoring.
| Alias | nTrees |
|---|---|
| Default | MACINT |
| Minimum value | 1 |
quantiles=list(double-1 <, double-2, ...>)
specifies a list of quantile values to compute for quantile regression forest predictions.
rbaImp=TRUE | FALSE
specifies variable importance using the random branch assignments (RBA) method.
| Default | FALSE |
|---|
seed=double
specifies the seed for the random number generator. By default, the random number stream is based on the computer clock. Negative values also result in random number streams based on the computer clock. If you want a reproducible random number sequence between runs, specify a value that is greater than zero.
| Default | 0.0 |
|---|---|
| Range | 0.0–MACINT |
* table=list(castable)
specifies the settings for an input table.
| Long form | table=list(name="table-name") |
|---|---|
| Shortcut form | table="table-name" |
The castable value can be one or more of the following:
caslib="string"
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the input table.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
|---|
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the input data.
whereTable=list(groupbytable)
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
casLib="string"
specifies the caslib for the filter table. By default, the active caslib is used.
dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter.
* name="table-name"
specifies the name of the filter table.
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of the format field plus the length of the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
where="where-expression"
specifies an expression for subsetting the data from the filter table.
target="variable-name"
specifies the target variable when scoring a data set. If the target variable name in the tree model is the same in the scored table, then this option is not required.
treeError=TRUE | FALSE
when set to True, the error is computed for each tree.
| Default | FALSE |
|---|
treeVotes=TRUE | FALSE
requests that the scored table generated by scoring forest is enhanced with information about the votes of the individual trees.
| Default | FALSE |
|---|
varIntImp=integer
requests variable interaction importance and specifies the maximum degree of interaction.
| Default | 1 |
|---|---|
| Range | 0–3 |