builtins

genmodScore

Description

creates a table on the server that contains results from scoring observations by using a fitted model.

regression.genmodScore <result=results> <status=rc> / alpha=double, casOut={ 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", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={ "string-1" <, "string-2", ...> } }, cBar="string", copyVars="ALL" | "ALL_NUMERIC" | { "variable-name-1" <, "variable-name-2", ...> }, difChisq="string", difDev="string", display={ caseSensitive=TRUE | FALSE, exclude=TRUE | FALSE, excludeAll=TRUE | FALSE, keyIsPath=TRUE | FALSE, names={ "string-1" <, "string-2", ...> }, pathType="LABEL" | "NAME", traceNames=TRUE | FALSE }, fitData=TRUE | FALSE, h="string", into="string", intoCutpt=double, ipred="string", lcl="string", lclm="string", level="string", obscat=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 }, pred="string", resChi="string", resDev="string", resLik="string", resRaw="string", 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" } }, resWork="string", role="string", stdResChi="string", stdResDev="string", stdXBeta="string", table={ caslib="string", computedOnDemand=TRUE | FALSE, computedVars={ { format="string", formattedLength=integer, label="string", 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, ...> }, groupBy={ { format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer }, {...} }, groupByMode="NOSORT" | "REDISTRIBUTE", 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", orderBy={ { format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer }, {...} }, singlePass=TRUE | FALSE, vars={ { format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer }, {...} }, where="where-expression", whereTable={ casLib="string", dataSourceOptions={ adls_noreq-parameters | bigquery-parameters | cas_noreq-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" } }, ucl="string", uclm="string", xBeta="string" ;
Settings
ParameterDescription
alpha specifies the significance level to use for the construction of confidence intervals. By default, this is set to the global significance level. Range: (0, 1)
casOut specifies the settings for an output table. For more information about specifying the casOut parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
casOut.caslib specifies the caslib for the output table. By default, the active caslib is used.
casOut.compress specifies whether to use data compression for the output table. When set to TRUE, the output table is compressed. When set to FALSE, the output table is not compressed. If this parameter is omitted, the compression setting for the caslib is used.
casOut.indexVars specifies one or more variables to be indexed.
casOut.label specifies the label for the output table.
casOut.lifetime specifies the number of hours before the table expires. When this parameter is omitted, the lifetime is determined by the caslib.
casOut.maxMemSize specifies the maximum amount of memory (in bytes) to use per node when loading the output table. When this parameter is omitted, the maximum memory size is determined by the caslib.
casOut.memoryFormat specifies the memory format to use when loading the output table. You can specify one of the following values: DVR: specifies that the table is loaded as a dynamically sized memory table in a format that optimizes for data transfer. You should use this option only when the tables do not need to be updated. This is an alias for the V9 format. INHERIT: specifies that the table uses the memory format of the original table. This option is valid only when the table is already loaded into memory. STANDARD: specifies that the table is loaded in a dynamically sized memory table in a format that optimizes for update activity. This is an alias for the V8 format. If this parameter is omitted, the memory format is determined by the caslib.
casOut.name specifies the name of the output table.
casOut.promote specifies whether the output table is promoted. When set to TRUE, the output table is promoted. When set to FALSE, the output table is not promoted. If this parameter is omitted, the promote setting for the caslib is used.
casOut.replace specifies whether to replace an existing table. When set to TRUE, an existing table with the same name is replaced. When set to FALSE, an existing table with the same name is not replaced. If this parameter is omitted, the replace setting for the caslib is used.
casOut.replication specifies the number of replica copies for the table. When this parameter is omitted, the replication setting for the caslib is used.
casOut.tableRedistUpPolicy specifies the table redistribution policy to use when updating the output table. You can specify one of the following values: DEFER: specifies that the table redistribution is deferred until the next update. NOREDIST: specifies that the table is not redistributed when updated. Note: This parameter can lead to suboptimal performance if the table data becomes skewed. REBALANCE: specifies that the table is rebalanced by redistributing the data when updated. If this parameter is omitted, the table redistribution policy is determined by the caslib.
casOut.threadBlockSize specifies the thread block size to use when loading the output table. When this parameter is omitted, the thread block size is determined by the caslib.
casOut.timeStamp specifies the time stamp for the output table.
casOut.where specifies a WHERE expression for the output table.
cBar names the confidence interval displacement, which measures the overall change in the global regression estimates that can be attributed to deleting the individual observation.
copyVars specifies a list of one or more variables to be copied from the input table to the output table. You can alternatively specify the value ALL, or ALL_NUMERIC, which respectively copies all variables, or all numeric variables from the input table to the output table.
difChisq names the change in the Pearson chi-square statistic that can be attributed to deleting the individual observation.
difDev names the change in the deviance that can be attributed to deleting the individual observation.
display 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).
display.caseSensitive specifies whether to match table names by case. When set to TRUE, table names are matched by case. When set to FALSE, table names are not matched by case.
display.exclude specifies whether to exclude tables from the list. When set to TRUE, tables are excluded from the list. When set to FALSE, tables are not excluded from the list.
display.excludeAll specifies whether to exclude all tables from the list. When set to TRUE, all tables are excluded from the list. When set to FALSE, all tables are not excluded from the list.
display.keyIsPath specifies whether the table name is a path. When set to TRUE, the table name is a path. When set to FALSE, the table name is not a path.
display.names specifies a list of table names to display.
display.pathType specifies the path type to use when matching table names. You can specify one of the following values: LABEL: specifies that the path type is a label. NAME: specifies that the path type is a name.
display.traceNames specifies whether to trace table names. When set to TRUE, table names are traced. When set to FALSE, table names are not traced.
fitData when set to True, specifies that the data to be scored were also used to fit the model. Default: FALSE
h names the leverage of the observation. Alias: hatDiag
into names the predicted response level.
intoCutpt specifies the predicted event probability that determines the predicted binary response level. Default: 0.5
ipred names the individual predicted value for a cumulative link. If you do not specify any output statistics, then by default the predicted value is named _IPRED_. Aliases: ip, individual
lcl names the lower bound of a confidence interval for the linear predictor. Aliases: lowerXBeta, lowerLinP
lclm names the lower bound of a confidence interval for the mean. Aliases: lower, lowerMean
level names the ordered response level.
obscat when set to True, computes multinomial output statistics at the observed response level. Default: FALSE
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
outputTables.groupByVarsRaw specifies whether to group by raw variables. When set to TRUE, raw variables are grouped. When set to FALSE, raw variables are not grouped.
outputTables.includeAll specifies whether to include all tables. When set to TRUE, all tables are included. When set to FALSE, all tables are not included.
outputTables.names specifies a list of table names to save as CAS tables on the server.
outputTables.repeated specifies whether to save repeated tables. When set to TRUE, repeated tables are saved. When set to FALSE, repeated tables are not saved.
outputTables.replace specifies whether to replace existing tables. When set to TRUE, existing tables are replaced. When set to FALSE, existing tables are not replaced.
pred names the predicted value. If you do not specify any output statistics, then by default the predicted value is named _PRED_. Aliases: p, predicted, iLink, mean
resChi names the Pearson chi-square residual. Aliases: pearson, pears
resDev names the deviance residual. Alias: devResid
resLik names the likelihood residual (likelihood displacement). Aliases: likeDist, ld, resLike
resRaw names the raw residual. Aliases: r, resid, residual, rawResid
restore 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:
restore.caslib 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.
restore.dataSourceOptions specifies data source options.
restore.name specifies the name of the input table.
restore.whereTable 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.
restore.whereTable.casLib specifies the caslib for the filter table. By default, the active caslib is used.
restore.whereTable.dataSourceOptions specifies data source options.
restore.whereTable.importOptions specifies the settings for reading a table from a data source.
restore.whereTable.name specifies the name of the filter table.
restore.whereTable.vars specifies the variable names to use from the filter table.
restore.whereTable.vars.format specifies the format to apply to the variable.
restore.whereTable.vars.formattedLength specifies the length of the format field plus the length of the format precision.
restore.whereTable.vars.label specifies the descriptive label for the variable.
restore.whereTable.vars.name specifies the name for the variable.
restore.whereTable.vars.nfd specifies the length of the format precision.
restore.whereTable.vars.nfl specifies the length of the format field.
restore.whereTable.where specifies an expression for subsetting the data from the filter table.
resWork names the working residual.
role identifies the training, validation, and test roles for the observations.
stdResChi names the standardized Pearson chi-square residual. Aliases: adjPearson, adjPears
stdResDev names the standardized deviance residual. Alias: stdDevResid
stdXBeta names the standard error of the linear predictor. Alias: stdP
table specifies the input data table. For more information about specifying the table parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).
table.caslib specifies the caslib for the input table. By default, the active caslib is used.
table.computedOnDemand specifies whether to compute the columns on demand. When set to TRUE, the computed columns are loaded on demand. When set to FALSE, the computed columns are not loaded on demand.
table.computedVars specifies a list of computed variables to add to the table.
table.computedVars.format specifies the format to apply to the variable.
table.computedVars.formattedLength specifies the length of the format field plus the length of the format precision.
table.computedVars.label specifies the descriptive label for the variable.
table.computedVars.name specifies the name for the variable.
table.computedVars.nfd specifies the length of the format precision.
table.computedVars.nfl specifies the length of the format field.
table.computedVarsProgram specifies a WHERE expression for the computed variables.
table.dataSourceOptions specifies data source options.
table.groupBy specifies a list of variables to group by.
table.groupBy.format specifies the format to apply to the variable.
table.groupBy.formattedLength specifies the length of the format field plus the length of the format precision.
table.groupBy.label specifies the descriptive label for the variable.
table.groupBy.name specifies the name for the variable.
table.groupBy.nfd specifies the length of the format precision.
table.groupBy.nfl specifies the length of the format field.
table.groupByMode specifies the grouping mode. You can specify one of the following values: NOSORT: specifies that the table is not sorted. REDISTRIBUTE: specifies that the table is rebalanced by redistributing the data when grouped.
table.importOptions specifies the settings for reading a table from a data source.
table.name specifies the name of the input table.
table.orderBy specifies a list of variables to order by.
table.orderBy.format specifies the format to apply to the variable.
table.orderBy.formattedLength specifies the length of the format field plus the length of the format precision.
table.orderBy.label specifies the descriptive label for the variable.
table.orderBy.name specifies the name for the variable.
table.orderBy.nfd specifies the length of the format precision.
table.orderBy.nfl specifies the length of the format field.
table.singlePass specifies whether to use single pass processing. When set to TRUE, single pass processing is used. When set to FALSE, single pass processing is not used.
table.vars specifies a list of variables to use from the input table.
table.vars.format specifies the format to apply to the variable.
table.vars.formattedLength specifies the length of the format field plus the length of the format precision.
table.vars.label specifies the descriptive label for the variable.
table.vars.name specifies the name for the variable.
table.vars.nfd specifies the length of the format precision.
table.vars.nfl specifies the length of the format field.
table.where specifies an expression for subsetting the data from the input table.
table.whereTable 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.
table.whereTable.casLib specifies the caslib for the filter table. By default, the active caslib is used.
table.whereTable.dataSourceOptions specifies data source options.
table.whereTable.importOptions specifies the settings for reading a table from a data source.
table.whereTable.name specifies the name of the filter table.
table.whereTable.vars specifies the variable names to use from the filter table.
table.whereTable.vars.format specifies the format to apply to the variable.
table.whereTable.vars.formattedLength specifies the length of the format field plus the length of the format precision.
table.whereTable.vars.label specifies the descriptive label for the variable.
table.whereTable.vars.name specifies the name for the variable.
table.whereTable.vars.nfd specifies the length of the format precision.
table.whereTable.vars.nfl specifies the length of the format field.
table.whereTable.where specifies an expression for subsetting the data from the filter table.
ucl names the upper bound of a confidence interval for the linear predictor. Aliases: upperXBeta, upperLinP
uclm names the upper bound of a confidence interval for the mean. Aliases: upper, upperMean
xBeta names the linear predictor. Alias: linP

Examples

FAQ

What is the genmodScore action?
What is the CASL syntax for the genmodScore action?
Summary: Input and Output Tables
What is the `alpha` parameter?
What is the `casOut` parameter?
What is the `cBar` parameter?
What is the `copyVars` parameter?
What is the `difChisq` parameter?
What is the `difDev` parameter?
What is the `display` parameter?
What is the `fitData` parameter?
What is the `h` parameter?
What is the `into` parameter?
What is the `intoCutpt` parameter?
What is the `ipred` parameter?
What is the `lcl` parameter?
What is the `lclm` parameter?
What is the `level` parameter?
What is the `obscat` parameter?
What is the `outputTables` parameter?
What is the `pred` parameter?
What is the `resChi` parameter?
What is the `resDev` parameter?
What is the `resLik` parameter?
What is the `resRaw` parameter?
What is the `restore` parameter?
What is the `resWork` parameter?
What is the `role` parameter?
What is the `stdResChi` parameter?
What is the `stdResDev` parameter?
What is the `stdXBeta` parameter?
What is the `table` parameter?
What is the `ucl` parameter?
What is the `uclm` parameter?
What is the `xBeta` parameter?