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
alphaspecifies the significance level to use for the construction of confidence intervals. By default, this is set to the global significance level. Range: (0, 1)
casOutspecifies 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.caslibspecifies the caslib for the output table. By default, the active caslib is used.
casOut.compressspecifies 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.indexVarsspecifies one or more variables to be indexed.
casOut.labelspecifies the label for the output table.
casOut.lifetimespecifies the number of hours before the table expires. When this parameter is omitted, the lifetime is determined by the caslib.
casOut.maxMemSizespecifies 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.memoryFormatspecifies 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.namespecifies the name of the output table.
casOut.promotespecifies 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.replacespecifies 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.replicationspecifies the number of replica copies for the table. When this parameter is omitted, the replication setting for the caslib is used.
casOut.tableRedistUpPolicyspecifies 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.threadBlockSizespecifies 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.timeStampspecifies the time stamp for the output table.
casOut.wherespecifies a WHERE expression for the output table.
cBarnames the confidence interval displacement, which measures the overall change in the global regression estimates that can be attributed to deleting the individual observation.
copyVarsspecifies 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.
difChisqnames the change in the Pearson chi-square statistic that can be attributed to deleting the individual observation.
difDevnames the change in the deviance that can be attributed to deleting the individual observation.
displayspecifies 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.caseSensitivespecifies 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.excludespecifies 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.excludeAllspecifies 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.keyIsPathspecifies 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.namesspecifies a list of table names to display.
display.pathTypespecifies 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.traceNamesspecifies whether to trace table names. When set to TRUE, table names are traced. When set to FALSE, table names are not traced.
fitDatawhen set to True, specifies that the data to be scored were also used to fit the model. Default: FALSE
hnames the leverage of the observation. Alias: hatDiag
intonames the predicted response level.
intoCutptspecifies the predicted event probability that determines the predicted binary response level. Default: 0.5
iprednames 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
lclnames the lower bound of a confidence interval for the linear predictor. Aliases: lowerXBeta, lowerLinP
lclmnames the lower bound of a confidence interval for the mean. Aliases: lower, lowerMean
levelnames the ordered response level.
obscatwhen set to True, computes multinomial output statistics at the observed response level. Default: FALSE
outputTableslists 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.groupByVarsRawspecifies whether to group by raw variables. When set to TRUE, raw variables are grouped. When set to FALSE, raw variables are not grouped.
outputTables.includeAllspecifies whether to include all tables. When set to TRUE, all tables are included. When set to FALSE, all tables are not included.
outputTables.namesspecifies a list of table names to save as CAS tables on the server.
outputTables.repeatedspecifies whether to save repeated tables. When set to TRUE, repeated tables are saved. When set to FALSE, repeated tables are not saved.
outputTables.replacespecifies whether to replace existing tables. When set to TRUE, existing tables are replaced. When set to FALSE, existing tables are not replaced.
prednames 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
resChinames the Pearson chi-square residual. Aliases: pearson, pears
resDevnames the deviance residual. Alias: devResid
resLiknames the likelihood residual (likelihood displacement). Aliases: likeDist, ld, resLike
resRawnames the raw residual. Aliases: r, resid, residual, rawResid
restorerestores 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.caslibspecifies 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.dataSourceOptionsspecifies data source options.
restore.namespecifies the name of the input table.
restore.whereTablespecifies 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.casLibspecifies the caslib for the filter table. By default, the active caslib is used.
restore.whereTable.dataSourceOptionsspecifies data source options.
restore.whereTable.importOptionsspecifies the settings for reading a table from a data source.
restore.whereTable.namespecifies the name of the filter table.
restore.whereTable.varsspecifies the variable names to use from the filter table.
restore.whereTable.vars.formatspecifies the format to apply to the variable.
restore.whereTable.vars.formattedLengthspecifies the length of the format field plus the length of the format precision.
restore.whereTable.vars.labelspecifies the descriptive label for the variable.
restore.whereTable.vars.namespecifies the name for the variable.
restore.whereTable.vars.nfdspecifies the length of the format precision.
restore.whereTable.vars.nflspecifies the length of the format field.
restore.whereTable.wherespecifies an expression for subsetting the data from the filter table.
resWorknames the working residual.
roleidentifies the training, validation, and test roles for the observations.
stdResChinames the standardized Pearson chi-square residual. Aliases: adjPearson, adjPears
stdResDevnames the standardized deviance residual. Alias: stdDevResid
stdXBetanames the standard error of the linear predictor. Alias: stdP
tablespecifies the input data table. For more information about specifying the table parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).
table.caslibspecifies the caslib for the input table. By default, the active caslib is used.
table.computedOnDemandspecifies 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.computedVarsspecifies a list of computed variables to add to the table.
table.computedVars.formatspecifies the format to apply to the variable.
table.computedVars.formattedLengthspecifies the length of the format field plus the length of the format precision.
table.computedVars.labelspecifies the descriptive label for the variable.
table.computedVars.namespecifies the name for the variable.
table.computedVars.nfdspecifies the length of the format precision.
table.computedVars.nflspecifies the length of the format field.
table.computedVarsProgramspecifies a WHERE expression for the computed variables.
table.dataSourceOptionsspecifies data source options.
table.groupByspecifies a list of variables to group by.
table.groupBy.formatspecifies the format to apply to the variable.
table.groupBy.formattedLengthspecifies the length of the format field plus the length of the format precision.
table.groupBy.labelspecifies the descriptive label for the variable.
table.groupBy.namespecifies the name for the variable.
table.groupBy.nfdspecifies the length of the format precision.
table.groupBy.nflspecifies the length of the format field.
table.groupByModespecifies 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.importOptionsspecifies the settings for reading a table from a data source.
table.namespecifies the name of the input table.
table.orderByspecifies a list of variables to order by.
table.orderBy.formatspecifies the format to apply to the variable.
table.orderBy.formattedLengthspecifies the length of the format field plus the length of the format precision.
table.orderBy.labelspecifies the descriptive label for the variable.
table.orderBy.namespecifies the name for the variable.
table.orderBy.nfdspecifies the length of the format precision.
table.orderBy.nflspecifies the length of the format field.
table.singlePassspecifies 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.varsspecifies a list of variables to use from the input table.
table.vars.formatspecifies the format to apply to the variable.
table.vars.formattedLengthspecifies the length of the format field plus the length of the format precision.
table.vars.labelspecifies the descriptive label for the variable.
table.vars.namespecifies the name for the variable.
table.vars.nfdspecifies the length of the format precision.
table.vars.nflspecifies the length of the format field.
table.wherespecifies an expression for subsetting the data from the input table.
table.whereTablespecifies 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.casLibspecifies the caslib for the filter table. By default, the active caslib is used.
table.whereTable.dataSourceOptionsspecifies data source options.
table.whereTable.importOptionsspecifies the settings for reading a table from a data source.
table.whereTable.namespecifies the name of the filter table.
table.whereTable.varsspecifies the variable names to use from the filter table.
table.whereTable.vars.formatspecifies the format to apply to the variable.
table.whereTable.vars.formattedLengthspecifies the length of the format field plus the length of the format precision.
table.whereTable.vars.labelspecifies the descriptive label for the variable.
table.whereTable.vars.namespecifies the name for the variable.
table.whereTable.vars.nfdspecifies the length of the format precision.
table.whereTable.vars.nflspecifies the length of the format field.
table.whereTable.wherespecifies an expression for subsetting the data from the filter table.
uclnames the upper bound of a confidence interval for the linear predictor. Aliases: upperXBeta, upperLinP
uclmnames the upper bound of a confidence interval for the mean. Aliases: upper, upperMean
xBetanames 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?