Regression Action Set

Provides actions for fitting linear, generalized linear, and logistic models

logisticOddsRatio Action

creates a table that compares subpopulations by using odds ratios..

CASL Syntax
Summary: Input and Output Tables
Parameter Descriptions

CASL Syntax

regression.logisticOddsRatio <result=results> <status=rc> /

alpha=double,

at={{

level="ALL" | "REF" | "string" | {"string-1" <, "string-2", ...>},

value=double | {double-1 <, double-2, ...>},

var="variable-name"

}, {...}},

diff="ALL" | "REF",

display={

caseSensitive=TRUE | FALSE,

exclude=TRUE | FALSE,

excludeAll=TRUE | FALSE,

keyIsPath=TRUE | FALSE,

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

pathType="LABEL" | "NAME",

traceNames=TRUE | FALSE

outputTables={

groupByVarsRaw=TRUE | FALSE,

includeAll=TRUE | FALSE,

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},

repeated=TRUE | FALSE,

replace=TRUE | FALSE

restore={

caslib="string",

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

name="table-name",

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}

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

unit={{

stderr=TRUE | FALSE,

value=double | {double-1 <, double-2, ...>},

var="variable-name"

}, {...}},

vars={{

at={{

level="ALL" | "REF" | "string" | {"string-1" <, "string-2", ...>},

value=double | {double-1 <, double-2, ...>},

var="variable-name"

}, {...}},

stderr=TRUE | FALSE,

unit=double | {double-1 <, double-2, ...>},

var={"variable-name-1" <, "variable-name-2", ...>}

}, {...}}

;

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
restore	—	restores regression models from a binary large object (BLOB).

Parameters for Creating Output Tables
Parameter	Subparameter	Description
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

alpha=double

specifies the significance level of the confidence limits.

Default	0.05
Range	(0, 1)

at={{orAtOpts-1} <, {orAtOpts-2}, ...>}

changes the default fixed values or levels for covariates that interact with the odds ratio variable.

The orAtOpts value can be one or more of the following:

level="ALL" | "REF" | "string" | {"string-1" <, "string-2", ...>}

specifies fixed levels for a classification covariate that interacts with the odds ratio variable.

Default	REF
ALL	specifies all levels of the classification variable.
REF	specifies the reference level of the classification variable.

value=double | {double-1 <, double-2, ...>}

specifies fixed values for a continuous covariate that interacts with the odds ratio variable.

* var="variable-name"

specifies a covariate that interacts with the odds ratio variable.

diff="ALL" | "REF"

specifies which pairs of response levels to compare.

Default	REF

ALL

specifies all levels of the classification variable.

REF

specifies the reference level of the classification variable.

display={displayTables}

specifies a list of results tables to send to the client for display.

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

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

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

Alias	displayOut

restore={castable}

restores regression models from a binary large object (BLOB).

Long form	restore={name="table-name"}
Shortcut form	restore="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
Aliases	dataSource

* name="table-name"

specifies the name of the input table.

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

unit={{orUnitOpts-1} <, {orUnitOpts-2}, ...>}

changes the default units of change for continuous odds ratio variables.

The orUnitOpts value can be one or more of the following:

stderr=TRUE | FALSE

when set to True, specifies that the units of change for a continuous odds ratio variable are multiples of the standard error.

Default	FALSE

value=double | {double-1 <, double-2, ...>}

specifies units of change for a continuous odds ratio variable.

* var="variable-name"

specifies a continuous odds ratio variable.

vars={{orSpec-1} <, {orSpec-2}, ...>}

specifies variables for which odds ratios are computed.

Aliases	oddsratios
Aliases	oddsratio

The orSpec value can be one or more of the following:

at={{orSpecAt-1} <, {orSpecAt-2}, ...>}

specifies fixed values or levels for covariates that interact with the odds ratio variable.

The orSpecAt value can be one or more of the following:

level="ALL" | "REF" | "string" | {"string-1" <, "string-2", ...>}

specifies fixed levels for a classification covariate that interacts with the odds ratio variable.

Default	REF
ALL	specifies all levels of the classification variable.
REF	specifies the reference level of the classification variable.

value=double | {double-1 <, double-2, ...>}

specifies fixed values for a continuous covariate that interacts with the odds ratio variable.

* var="variable-name"

specifies a covariate that interacts with the odds ratio variable.

stderr=TRUE | FALSE

when set to True, specifies that the units of change for a continuous odds ratio variable are multiples of the standard error.

Default	FALSE

unit=double | {double-1 <, double-2, ...>}

specifies units of change for a continuous odds ratio variable.

* var={"variable-name-1" <, "variable-name-2", ...>}

specifies variables for which odds ratios are computed.

logisticOddsRatio Action

creates a table that compares subpopulations by using odds ratios..

Lua Syntax
Summary: Input and Output Tables
Parameter Descriptions

Lua Syntax

results, info = s:regression_logisticOddsRatio{

alpha=double,

at={{

level="ALL" | "REF" | "string" | {"string-1" <, "string-2", ...>},

value=double | {double-1 <, double-2, ...>},

var="variable-name"

}, {...}},

diff="ALL" | "REF",

display={

caseSensitive=true | false,

exclude=true | false,

excludeAll=true | false,

keyIsPath=true | false,

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

pathType="LABEL" | "NAME",

traceNames=true | false

outputTables={

groupByVarsRaw=true | false,

includeAll=true | false,

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},

repeated=true | false,

replace=true | false

restore={

caslib="string",

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

name="table-name",

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

unit={{

stderr=true | false,

value=double | {double-1 <, double-2, ...>},

var="variable-name"

}, {...}},

vars={{

at={{

level="ALL" | "REF" | "string" | {"string-1" <, "string-2", ...>},

value=double | {double-1 <, double-2, ...>},

var="variable-name"

}, {...}},

stderr=true | false,

unit=double | {double-1 <, double-2, ...>},

var={"variable-name-1" <, "variable-name-2", ...>}

}, {...}}

}

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
restore	—	restores regression models from a binary large object (BLOB).

Parameters for Creating Output Tables
Parameter	Subparameter	Description
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

alpha=double

specifies the significance level of the confidence limits.

Default	0.05
Range	(0, 1)

at={{orAtOpts-1} <, {orAtOpts-2}, ...>}

changes the default fixed values or levels for covariates that interact with the odds ratio variable.

The orAtOpts value can be one or more of the following:

level="ALL" | "REF" | "string" | {"string-1" <, "string-2", ...>}

specifies fixed levels for a classification covariate that interacts with the odds ratio variable.

Default	REF
ALL	specifies all levels of the classification variable.
REF	specifies the reference level of the classification variable.

value=double | {double-1 <, double-2, ...>}

specifies fixed values for a continuous covariate that interacts with the odds ratio variable.

* var="variable-name"

specifies a covariate that interacts with the odds ratio variable.

diff="ALL" | "REF"

specifies which pairs of response levels to compare.

Default	REF

ALL

specifies all levels of the classification variable.

REF

specifies the reference level of the classification variable.

display={displayTables}

specifies a list of results tables to send to the client for display.

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

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

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

Alias	displayOut

restore={castable}

restores regression models from a binary large object (BLOB).

Long form	restore={name="table-name"}
Shortcut form	restore="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
Aliases	dataSource

* name="table-name"

specifies the name of the input table.

whereTable={groupbytable}

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

unit={{orUnitOpts-1} <, {orUnitOpts-2}, ...>}

changes the default units of change for continuous odds ratio variables.

The orUnitOpts value can be one or more of the following:

stderr=true | false

when set to True, specifies that the units of change for a continuous odds ratio variable are multiples of the standard error.

Default	false

value=double | {double-1 <, double-2, ...>}

specifies units of change for a continuous odds ratio variable.

* var="variable-name"

specifies a continuous odds ratio variable.

vars={{orSpec-1} <, {orSpec-2}, ...>}

specifies variables for which odds ratios are computed.

Aliases	oddsratios
Aliases	oddsratio

The orSpec value can be one or more of the following:

at={{orSpecAt-1} <, {orSpecAt-2}, ...>}

specifies fixed values or levels for covariates that interact with the odds ratio variable.

The orSpecAt value can be one or more of the following:

level="ALL" | "REF" | "string" | {"string-1" <, "string-2", ...>}

specifies fixed levels for a classification covariate that interacts with the odds ratio variable.

Default	REF
ALL	specifies all levels of the classification variable.
REF	specifies the reference level of the classification variable.

value=double | {double-1 <, double-2, ...>}

specifies fixed values for a continuous covariate that interacts with the odds ratio variable.

* var="variable-name"

specifies a covariate that interacts with the odds ratio variable.

stderr=true | false

when set to True, specifies that the units of change for a continuous odds ratio variable are multiples of the standard error.

Default	false

unit=double | {double-1 <, double-2, ...>}

specifies units of change for a continuous odds ratio variable.

* var={"variable-name-1" <, "variable-name-2", ...>}

specifies variables for which odds ratios are computed.

logisticOddsRatio Action

creates a table that compares subpopulations by using odds ratios..

Python Syntax
Summary: Input and Output Tables
Parameter Descriptions

Python Syntax

results=s.regression.logisticOddsRatio(

alpha=double,

at=[{

"level":"ALL" | "REF" | "string" | ["string-1" <, "string-2", ...>],

"value":double | [double-1 <, double-2, ...>],

"var":"variable-name"

}<, {...}>],

diff="ALL" | "REF",

display={

"caseSensitive":True | False,

"exclude":True | False,

"excludeAll":True | False,

"keyIsPath":True | False,

"names":["string-1" <, "string-2", ...>],

"pathType":"LABEL" | "NAME",

"traceNames":True | False

outputTables={

"groupByVarsRaw":True | False,

"includeAll":True | False,

"names":["string-1" <, "string-2", ...>] | {"key-1":{casouttable-1} <, "key-2":{casouttable-2}, ...>},

"repeated":True | False,

"replace":True | False

restore={

"caslib":"string",

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

"name":"table-name",

"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}

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

unit=[{

"stderr":True | False,

"value":double | [double-1 <, double-2, ...>],

"var":"variable-name"

}<, {...}>],

vars=[{

"at":[{

"level":"ALL" | "REF" | "string" | ["string-1" <, "string-2", ...>],

"value":double | [double-1 <, double-2, ...>],

"var":"variable-name"

}<, {...}>],

"stderr":True | False,

"unit":double | [double-1 <, double-2, ...>],

"var":["variable-name-1" <, "variable-name-2", ...>]

}<, {...}>]

)

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
restore	—	restores regression models from a binary large object (BLOB).

Parameters for Creating Output Tables
Parameter	Subparameter	Description
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

alpha=double

specifies the significance level of the confidence limits.

Default	0.05
Range	(0, 1)

at=[{orAtOpts-1} <, {orAtOpts-2}, ...>]

changes the default fixed values or levels for covariates that interact with the odds ratio variable.

The orAtOpts value can be one or more of the following:

"level":"ALL" | "REF" | "string" | ["string-1" <, "string-2", ...>]

specifies fixed levels for a classification covariate that interacts with the odds ratio variable.

Default	REF
ALL	specifies all levels of the classification variable.
REF	specifies the reference level of the classification variable.

"value":double | [double-1 <, double-2, ...>]

specifies fixed values for a continuous covariate that interacts with the odds ratio variable.

* "var":"variable-name"

specifies a covariate that interacts with the odds ratio variable.

diff="ALL" | "REF"

specifies which pairs of response levels to compare.

Default	REF

ALL

specifies all levels of the classification variable.

REF

specifies the reference level of the classification variable.

display={displayTables}

specifies a list of results tables to send to the client for display.

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

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

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

Alias	displayOut

restore={castable}

restores regression models from a binary large object (BLOB).

Long form	restore={"name":"table-name"}
Shortcut form	restore="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
Aliases	dataSource

* "name":"table-name"

specifies the name of the input table.

"whereTable":{groupbytable}

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

unit=[{orUnitOpts-1} <, {orUnitOpts-2}, ...>]

changes the default units of change for continuous odds ratio variables.

The orUnitOpts value can be one or more of the following:

"stderr":True | False

when set to True, specifies that the units of change for a continuous odds ratio variable are multiples of the standard error.

Default	False

"value":double | [double-1 <, double-2, ...>]

specifies units of change for a continuous odds ratio variable.

* "var":"variable-name"

specifies a continuous odds ratio variable.

vars=[{orSpec-1} <, {orSpec-2}, ...>]

specifies variables for which odds ratios are computed.

Aliases	oddsratios
Aliases	oddsratio

The orSpec value can be one or more of the following:

"at":[{orSpecAt-1} <, {orSpecAt-2}, ...>]

specifies fixed values or levels for covariates that interact with the odds ratio variable.

The orSpecAt value can be one or more of the following:

"level":"ALL" | "REF" | "string" | ["string-1" <, "string-2", ...>]

specifies fixed levels for a classification covariate that interacts with the odds ratio variable.

Default	REF
ALL	specifies all levels of the classification variable.
REF	specifies the reference level of the classification variable.

"value":double | [double-1 <, double-2, ...>]

specifies fixed values for a continuous covariate that interacts with the odds ratio variable.

* "var":"variable-name"

specifies a covariate that interacts with the odds ratio variable.

"stderr":True | False

when set to True, specifies that the units of change for a continuous odds ratio variable are multiples of the standard error.

Default	False

"unit":double | [double-1 <, double-2, ...>]

specifies units of change for a continuous odds ratio variable.

* "var":["variable-name-1" <, "variable-name-2", ...>]

specifies variables for which odds ratios are computed.

logisticOddsRatio Action

creates a table that compares subpopulations by using odds ratios..

R Syntax
Summary: Input and Output Tables
Parameter Descriptions

R Syntax

results <– cas.regression.logisticOddsRatio(s,

alpha=double,

at=list( list(

level="ALL" | "REF" | "string" | list("string-1" <, "string-2", ...>),

value=double | list(double-1 <, double-2, ...>),

var="variable-name"

) <, list(...)>),

diff="ALL" | "REF",

display=list(

caseSensitive=TRUE | FALSE,

exclude=TRUE | FALSE,

excludeAll=TRUE | FALSE,

keyIsPath=TRUE | FALSE,

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

pathType="LABEL" | "NAME",

traceNames=TRUE | FALSE

outputTables=list(

groupByVarsRaw=TRUE | FALSE,

includeAll=TRUE | FALSE,

names=list("string-1" <, "string-2", ...>) | list(key-1=list(casouttable-1) <, key-2=list(casouttable-2), ...>),

repeated=TRUE | FALSE,

replace=TRUE | FALSE

restore=list(

caslib="string",

dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),

name="table-name",

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

unit=list( list(

stderr=TRUE | FALSE,

value=double | list(double-1 <, double-2, ...>),

var="variable-name"

) <, list(...)>),

vars=list( list(

at=list( list(

level="ALL" | "REF" | "string" | list("string-1" <, "string-2", ...>),

value=double | list(double-1 <, double-2, ...>),

var="variable-name"

) <, list(...)>),

stderr=TRUE | FALSE,

unit=double | list(double-1 <, double-2, ...>),

var=list("variable-name-1" <, "variable-name-2", ...>)

) <, list(...)>)

)

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
restore	—	restores regression models from a binary large object (BLOB).

Parameters for Creating Output Tables
Parameter	Subparameter	Description
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

alpha=double

specifies the significance level of the confidence limits.

Default	0.05
Range	(0, 1)

at=list( list(orAtOpts-1) <, list(orAtOpts-2), ...>)

changes the default fixed values or levels for covariates that interact with the odds ratio variable.

The orAtOpts value can be one or more of the following:

level="ALL" | "REF" | "string" | list("string-1" <, "string-2", ...>)

specifies fixed levels for a classification covariate that interacts with the odds ratio variable.

Default	REF
ALL	specifies all levels of the classification variable.
REF	specifies the reference level of the classification variable.

value=double | list(double-1 <, double-2, ...>)

specifies fixed values for a continuous covariate that interacts with the odds ratio variable.

* var="variable-name"

specifies a covariate that interacts with the odds ratio variable.

diff="ALL" | "REF"

specifies which pairs of response levels to compare.

Default	REF

ALL

specifies all levels of the classification variable.

REF

specifies the reference level of the classification variable.

display=list(displayTables)

specifies a list of results tables to send to the client for display.

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

outputTables=list(outputTables)

lists the names of results tables to save as CAS tables on the server.

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

Alias	displayOut

restore=list(castable)

restores regression models from a binary large object (BLOB).

Long form	restore=list(name="table-name")
Shortcut form	restore="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
Aliases	dataSource

* name="table-name"

specifies the name of the input table.

whereTable=list(groupbytable)

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

unit=list( list(orUnitOpts-1) <, list(orUnitOpts-2), ...>)

changes the default units of change for continuous odds ratio variables.

The orUnitOpts value can be one or more of the following:

stderr=TRUE | FALSE

when set to True, specifies that the units of change for a continuous odds ratio variable are multiples of the standard error.

Default	FALSE

value=double | list(double-1 <, double-2, ...>)

specifies units of change for a continuous odds ratio variable.

* var="variable-name"

specifies a continuous odds ratio variable.

vars=list( list(orSpec-1) <, list(orSpec-2), ...>)

specifies variables for which odds ratios are computed.

Aliases	oddsratios
Aliases	oddsratio

The orSpec value can be one or more of the following:

at=list( list(orSpecAt-1) <, list(orSpecAt-2), ...>)

specifies fixed values or levels for covariates that interact with the odds ratio variable.

The orSpecAt value can be one or more of the following:

level="ALL" | "REF" | "string" | list("string-1" <, "string-2", ...>)

specifies fixed levels for a classification covariate that interacts with the odds ratio variable.

Default	REF
ALL	specifies all levels of the classification variable.
REF	specifies the reference level of the classification variable.

value=double | list(double-1 <, double-2, ...>)

specifies fixed values for a continuous covariate that interacts with the odds ratio variable.

* var="variable-name"

specifies a covariate that interacts with the odds ratio variable.

stderr=TRUE | FALSE

when set to True, specifies that the units of change for a continuous odds ratio variable are multiples of the standard error.

Default	FALSE

unit=double | list(double-1 <, double-2, ...>)

specifies units of change for a continuous odds ratio variable.

* var=list("variable-name-1" <, "variable-name-2", ...>)

specifies variables for which odds ratios are computed.

Last updated: March 05, 2026