Fair AI Tools Action Set

Provides actions for calculating bias metrics and mitigating bias for predictive models.

assessBias Action

Calculate bias metrics for predictive models.

CASL Syntax

fairAITools.assessBias <result=results> <status=rc> /
code="string",
cutoff=double,
event="string",
frequency={
format="string",
formattedLength=integer,
label="string",
length=integer,
name="string",
nfd=integer,
nfl=integer,
type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
},
modelTable={
caslib="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
required parameter name="table-name"
},
modelTables={{
caslib="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
required parameter name="table-name"
}, {...}},
modelTableType="ASTORE" | "DATASTEP" | "NONE",
nBins=64-bit-integer,
required parameter predictedVariables={{
name="string"
}, {...}},
referenceLevel="string",
response={
name="string"
},
responseLevels={"string-1" <, "string-2", ...>},
rocStep=double,
scoredTable={
caslib="string",
compress=TRUE | FALSE,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
onDemand=TRUE | FALSE,
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
selectionDepth=64-bit-integer,
required parameter sensitiveVariable={
name="string"
},
required parameter table={
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
computedVarsProgram="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
onDemand=TRUE | FALSE,
where="where-expression",
whereTable={
casLib="string"
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-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}
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
weight={
format="string",
formattedLength=integer,
label="string",
length=integer,
name="string",
nfd=integer,
nfl=integer,
type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
}
;
indicates a required parameter

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.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

 modelTable

—

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step scoring code.

 modelTables

—

specifies the input tables that contain the model to explain. These tables must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies the tables.

required parametertable

—

specifies the input data table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

 scoredTable

—

specifies the output table to contain the scored outputs.

Parameter Descriptions

code="string"

specifies the DATA step code that describes the model or specifies the DS2 code that is used along with an analytic store that you specify in the modelTable or modelTables parameter.

cutoff=double

specifies the cutoff for the confusion matrix.

Alias intoCutPt
Default 0.5
Range (0, 1)

event="string"

specifies the formatted value of the response (target) variable that represents the event of interest.

frequency={casvardesc}

specifies the variable that contains frequency values.

For more information about specifying the frequency parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

Alias freq

modelTable={castable}

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step scoring code.

Long form modelTable={name="table-name"}
Shortcut form modelTable="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.

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases options
dataSource
* name="table-name"

specifies the name of the input table.

modelTables={{castable-1} <, {castable-2}, ...>}

specifies the input tables that contain the model to explain. These tables must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies the tables.

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.

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases options
dataSource
* name="table-name"

specifies the name of the input table.

modelTableType="ASTORE" | "DATASTEP" | "NONE"

specifies the type of scoring that the model table contains.

Default ASTORE
ASTORE

ASTORE

DATASTEP

DATA STEP

NONE

NO ASTORE or DATA STEP

nBins=64-bit-integer

specifies the number of bins to use in lift calculations.

Default 20
Range 2–100

* predictedVariables={{casvardesc-1} <, {casvardesc-2}, ...>}

specifies the list of variables that contain the model's predictions. The order of the variables must match the order that you specify in the responseLevels parameter.

name="string"

specifies the name for the variable.

referenceLevel="string"

specifies the reference level for the sensitive variable.

Alias baseLevel

response={casvardesc}

specifies the response (target) variable.

Alias target
name="string"

specifies the name for the variable.

responseLevels={"string-1" <, "string-2", ...>}

specifies the list of formatted values of the response (target) variable. The order of the variables must match the order that you specify in the predictedVariables parameter. If the event parameter is omitted, the first formatted value is assumed to be the event.

Alias targetLevels

rocStep=double

specifies the step size to use for the receiver operating characteristic (ROC) calculations.

Alias cutStep
Default 0.05
Range (0–0.5]

scoredTable={casouttable}

specifies the output table to contain the scored outputs.

For more information about specifying the scoredTable parameter, see the common casouttable (Form 2) parameter (Appendix A: Common Parameters).

selectionDepth=64-bit-integer

specifies the depth to use in lift calculations.

Default 10
Range (0–100]

* sensitiveVariable={casvardesc}

specifies the sensitive variable to use in bias calculations.

name="string"

specifies the name for the variable.

* table={castable}

specifies the input data 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 (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

onDemand=TRUE | FALSE

This parameter is deprecated.

Default TRUE
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 | 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 (Appendix A: Common Parameters).

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 (Appendix A: Common Parameters).

* 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.

weight={casvardesc}

specifies the variable that contains weight values.

For more information about specifying the weight parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

assessBias Action

Calculate bias metrics for predictive models.

Lua Syntax

results, info = s:fairAITools_assessBias{
code="string",
cutoff=double,
event="string",
frequency={
format="string",
formattedLength=integer,
label="string",
length=integer,
name="string",
nfd=integer,
nfl=integer,
type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
},
modelTable={
caslib="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
required parameter name="table-name"
},
modelTables={{
caslib="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
required parameter name="table-name"
}, {...}},
modelTableType="ASTORE" | "DATASTEP" | "NONE",
nBins=64-bit-integer,
required parameter predictedVariables={{
name="string"
}, {...}},
referenceLevel="string",
response={
name="string"
},
responseLevels={"string-1" <, "string-2", ...>},
rocStep=double,
scoredTable={
caslib="string",
compress=true | false,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
onDemand=true | false,
promote=true | false,
replace=true | false,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
selectionDepth=64-bit-integer,
required parameter sensitiveVariable={
name="string"
},
required parameter table={
caslib="string",
computedOnDemand=true | false,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
computedVarsProgram="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
onDemand=true | false,
where="where-expression",
whereTable={
casLib="string"
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-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}
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
weight={
format="string",
formattedLength=integer,
label="string",
length=integer,
name="string",
nfd=integer,
nfl=integer,
type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
}
}
indicates a required parameter

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.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

 modelTable

—

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step scoring code.

 modelTables

—

specifies the input tables that contain the model to explain. These tables must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies the tables.

required parametertable

—

specifies the input data table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

 scoredTable

—

specifies the output table to contain the scored outputs.

Parameter Descriptions

code="string"

specifies the DATA step code that describes the model or specifies the DS2 code that is used along with an analytic store that you specify in the modelTable or modelTables parameter.

cutoff=double

specifies the cutoff for the confusion matrix.

Alias intoCutPt
Default 0.5
Range (0, 1)

event="string"

specifies the formatted value of the response (target) variable that represents the event of interest.

frequency={casvardesc}

specifies the variable that contains frequency values.

For more information about specifying the frequency parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

Alias freq

modelTable={castable}

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step scoring code.

Long form modelTable={name="table-name"}
Shortcut form modelTable="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.

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases options
dataSource
* name="table-name"

specifies the name of the input table.

modelTables={{castable-1} <, {castable-2}, ...>}

specifies the input tables that contain the model to explain. These tables must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies the tables.

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.

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Aliases options
dataSource
* name="table-name"

specifies the name of the input table.

modelTableType="ASTORE" | "DATASTEP" | "NONE"

specifies the type of scoring that the model table contains.

Default ASTORE
ASTORE

ASTORE

DATASTEP

DATA STEP

NONE

NO ASTORE or DATA STEP

nBins=64-bit-integer

specifies the number of bins to use in lift calculations.

Default 20
Range 2–100

* predictedVariables={{casvardesc-1} <, {casvardesc-2}, ...>}

specifies the list of variables that contain the model's predictions. The order of the variables must match the order that you specify in the responseLevels parameter.

name="string"

specifies the name for the variable.

referenceLevel="string"

specifies the reference level for the sensitive variable.

Alias baseLevel

response={casvardesc}

specifies the response (target) variable.

Alias target
name="string"

specifies the name for the variable.

responseLevels={"string-1" <, "string-2", ...>}

specifies the list of formatted values of the response (target) variable. The order of the variables must match the order that you specify in the predictedVariables parameter. If the event parameter is omitted, the first formatted value is assumed to be the event.

Alias targetLevels

rocStep=double

specifies the step size to use for the receiver operating characteristic (ROC) calculations.

Alias cutStep
Default 0.05
Range (0–0.5]

scoredTable={casouttable}

specifies the output table to contain the scored outputs.

For more information about specifying the scoredTable parameter, see the common casouttable (Form 2) parameter (Appendix A: Common Parameters).

selectionDepth=64-bit-integer

specifies the depth to use in lift calculations.

Default 10
Range (0–100]

* sensitiveVariable={casvardesc}

specifies the sensitive variable to use in bias calculations.

name="string"

specifies the name for the variable.

* table={castable}

specifies the input data 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 (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

onDemand=true | false

This parameter is deprecated.

Default true
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 | 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 (Appendix A: Common Parameters).

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 (Appendix A: Common Parameters).

* 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.

weight={casvardesc}

specifies the variable that contains weight values.

For more information about specifying the weight parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

assessBias Action

Calculate bias metrics for predictive models.

Python Syntax

results=s.fairAITools.assessBias(
code="string",
cutoff=double,
event="string",
frequency={
"format":"string",
"formattedLength":integer,
"label":"string",
"length":integer,
"name":"string",
"nfd":integer,
"nfl":integer,
"type":"BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
},
modelTable={
"caslib":"string",
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},
required parameter "name":"table-name"
},
modelTables=[{
"caslib":"string",
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},
required parameter "name":"table-name"
}<, {...}>],
modelTableType="ASTORE" | "DATASTEP" | "NONE",
nBins=64-bit-integer,
required parameter predictedVariables=[{
"name":"string"
}<, {...}>],
referenceLevel="string",
response={
"name":"string"
},
responseLevels=["string-1" <, "string-2", ...>],
rocStep=double,
scoredTable={
"caslib":"string",
"compress":True | False,
"indexVars":["variable-name-1" <, "variable-name-2", ...>],
"label":"string",
"lifetime":64-bit-integer,
"maxMemSize":64-bit-integer,
"memoryFormat":"DVR" | "INHERIT" | "STANDARD",
"name":"table-name",
"onDemand":True | False,
"promote":True | False,
"replace":True | False,
"replication":integer,
"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",
"threadBlockSize":64-bit-integer,
"timeStamp":"string",
"where":["string-1" <, "string-2", ...>]
},
selectionDepth=64-bit-integer,
required parameter sensitiveVariable={
"name":"string"
},
required parameter table={
"caslib":"string",
"computedOnDemand":True | False,
"computedVars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"computedVarsProgram":"string",
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter "name":"table-name",
"onDemand":True | False,
"where":"where-expression",
"whereTable":{
"casLib":"string"
"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-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}
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter "name":"table-name"
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>]
"where":"where-expression"
}
},
weight={
"format":"string",
"formattedLength":integer,
"label":"string",
"length":integer,
"name":"string",
"nfd":integer,
"nfl":integer,
"type":"BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
}
)
indicates a required parameter

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.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

 modelTable

—

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step scoring code.

 modelTables

—

specifies the input tables that contain the model to explain. These tables must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies the tables.

required parametertable

—

specifies the input data table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

 scoredTable

—

specifies the output table to contain the scored outputs.

Parameter Descriptions

code="string"

specifies the DATA step code that describes the model or specifies the DS2 code that is used along with an analytic store that you specify in the modelTable or modelTables parameter.

cutoff=double

specifies the cutoff for the confusion matrix.

Alias intoCutPt
Default 0.5
Range (0, 1)

event="string"

specifies the formatted value of the response (target) variable that represents the event of interest.

frequency={casvardesc}

specifies the variable that contains frequency values.

For more information about specifying the frequency parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

Alias freq

modelTable={castable}

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step scoring code.

Long form modelTable={"name":"table-name"}
Shortcut form modelTable="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.

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies data source options.

Aliases options
dataSource
* "name":"table-name"

specifies the name of the input table.

modelTables=[{castable-1} <, {castable-2}, ...>]

specifies the input tables that contain the model to explain. These tables must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies the tables.

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.

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies data source options.

Aliases options
dataSource
* "name":"table-name"

specifies the name of the input table.

modelTableType="ASTORE" | "DATASTEP" | "NONE"

specifies the type of scoring that the model table contains.

Default ASTORE
ASTORE

ASTORE

DATASTEP

DATA STEP

NONE

NO ASTORE or DATA STEP

nBins=64-bit-integer

specifies the number of bins to use in lift calculations.

Default 20
Range 2–100

* predictedVariables=[{casvardesc-1} <, {casvardesc-2}, ...>]

specifies the list of variables that contain the model's predictions. The order of the variables must match the order that you specify in the responseLevels parameter.

"name":"string"

specifies the name for the variable.

referenceLevel="string"

specifies the reference level for the sensitive variable.

Alias baseLevel

response={casvardesc}

specifies the response (target) variable.

Alias target
"name":"string"

specifies the name for the variable.

responseLevels=["string-1" <, "string-2", ...>]

specifies the list of formatted values of the response (target) variable. The order of the variables must match the order that you specify in the predictedVariables parameter. If the event parameter is omitted, the first formatted value is assumed to be the event.

Alias targetLevels

rocStep=double

specifies the step size to use for the receiver operating characteristic (ROC) calculations.

Alias cutStep
Default 0.05
Range (0–0.5]

scoredTable={casouttable}

specifies the output table to contain the scored outputs.

For more information about specifying the scoredTable parameter, see the common casouttable (Form 2) parameter (Appendix A: Common Parameters).

selectionDepth=64-bit-integer

specifies the depth to use in lift calculations.

Default 10
Range (0–100]

* sensitiveVariable={casvardesc}

specifies the sensitive variable to use in bias calculations.

"name":"string"

specifies the name for the variable.

* table={castable}

specifies the input data 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 (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the input table.

"onDemand":True | False

This parameter is deprecated.

Default True
"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 | 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 (Appendix A: Common Parameters).

"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 (Appendix A: Common Parameters).

* "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.

weight={casvardesc}

specifies the variable that contains weight values.

For more information about specifying the weight parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

assessBias Action

Calculate bias metrics for predictive models.

R Syntax

results <– cas.fairAITools.assessBias(s,
code="string",
cutoff=double,
event="string",
frequency=list(
format="string",
formattedLength=integer,
label="string",
length=integer,
name="string",
nfd=integer,
nfl=integer,
type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
),
modelTable=list(
caslib="string",
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),
required parameter name="table-name"
),
modelTables=list( list(
caslib="string",
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),
required parameter name="table-name"
) <, list(...)>),
modelTableType="ASTORE" | "DATASTEP" | "NONE",
nBins=64-bit-integer,
required parameter predictedVariables=list( list(
name="string"
) <, list(...)>),
referenceLevel="string",
response=list(
name="string"
),
responseLevels=list("string-1" <, "string-2", ...>),
rocStep=double,
scoredTable=list(
caslib="string",
compress=TRUE | FALSE,
indexVars=list("variable-name-1" <, "variable-name-2", ...>),
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
onDemand=TRUE | FALSE,
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where=list("string-1" <, "string-2", ...>)
),
selectionDepth=64-bit-integer,
required parameter sensitiveVariable=list(
name="string"
),
required parameter table=list(
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
computedVarsProgram="string",
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters),
required parameter name="table-name",
onDemand=TRUE | FALSE,
where="where-expression",
whereTable=list(
casLib="string"
dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-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)
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
required parameter name="table-name"
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>)
where="where-expression"
)
),
weight=list(
format="string",
formattedLength=integer,
label="string",
length=integer,
name="string",
nfd=integer,
nfl=integer,
type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
)
)
indicates a required parameter

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.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

 modelTable

—

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step scoring code.

 modelTables

—

specifies the input tables that contain the model to explain. These tables must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies the tables.

required parametertable

—

specifies the input data table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

 scoredTable

—

specifies the output table to contain the scored outputs.

Parameter Descriptions

code="string"

specifies the DATA step code that describes the model or specifies the DS2 code that is used along with an analytic store that you specify in the modelTable or modelTables parameter.

cutoff=double

specifies the cutoff for the confusion matrix.

Alias intoCutPt
Default 0.5
Range (0, 1)

event="string"

specifies the formatted value of the response (target) variable that represents the event of interest.

frequency=list(casvardesc)

specifies the variable that contains frequency values.

For more information about specifying the frequency parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

Alias freq

modelTable=list(castable)

specifies the input table that contains the model to explain. This table must contain an analytic store or DATA step scoring code.

Long form modelTable=list(name="table-name")
Shortcut form modelTable="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.

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
* name="table-name"

specifies the name of the input table.

modelTables=list( list(castable-1) <, list(castable-2), ...>)

specifies the input tables that contain the model to explain. These tables must contain analytic stores, and you must also specify in the code parameter the DS2 code that accompanies the tables.

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.

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
* name="table-name"

specifies the name of the input table.

modelTableType="ASTORE" | "DATASTEP" | "NONE"

specifies the type of scoring that the model table contains.

Default ASTORE
ASTORE

ASTORE

DATASTEP

DATA STEP

NONE

NO ASTORE or DATA STEP

nBins=64-bit-integer

specifies the number of bins to use in lift calculations.

Default 20
Range 2–100

* predictedVariables=list( list(casvardesc-1) <, list(casvardesc-2), ...>)

specifies the list of variables that contain the model's predictions. The order of the variables must match the order that you specify in the responseLevels parameter.

name="string"

specifies the name for the variable.

referenceLevel="string"

specifies the reference level for the sensitive variable.

Alias baseLevel

response=list(casvardesc)

specifies the response (target) variable.

Alias target
name="string"

specifies the name for the variable.

responseLevels=list("string-1" <, "string-2", ...>)

specifies the list of formatted values of the response (target) variable. The order of the variables must match the order that you specify in the predictedVariables parameter. If the event parameter is omitted, the first formatted value is assumed to be the event.

Alias targetLevels

rocStep=double

specifies the step size to use for the receiver operating characteristic (ROC) calculations.

Alias cutStep
Default 0.05
Range (0–0.5]

scoredTable=list(casouttable)

specifies the output table to contain the scored outputs.

For more information about specifying the scoredTable parameter, see the common casouttable (Form 2) parameter (Appendix A: Common Parameters).

selectionDepth=64-bit-integer

specifies the depth to use in lift calculations.

Default 10
Range (0–100]

* sensitiveVariable=list(casvardesc)

specifies the sensitive variable to use in bias calculations.

name="string"

specifies the name for the variable.

* table=list(castable)

specifies the input data 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 (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the input table.

onDemand=TRUE | FALSE

This parameter is deprecated.

Default TRUE
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 | 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 (Appendix A: Common Parameters).

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 (Appendix A: Common Parameters).

* 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.

weight=list(casvardesc)

specifies the variable that contains weight values.

For more information about specifying the weight parameter, see the common casvardesc parameter (Appendix A: Common Parameters).

Last updated: November 23, 2025