Sampling and Partitioning Action Set: Syntax
Provides actions for sampling and partitioning of data
srs Action
Samples a proportion of data from the input table or partitions the data into no more than three portions.
CASL Syntax
Parameter Descriptions
attributes={{casinvardesc-1} <, {casinvardesc-2}, ...>}
changes the attributes of variables used in this action. Currently, attributes specified on the inputs and nominals parameter are ignored.
For more information about specifying the attributes parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | attribute |
diagnostics={_diagnostics}
eyecatcher="string"
specifies a quoted string that will be prefixed to any messages that are associated with this action invocation.
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).
fixedObs=64-bit-integer
specifies a fixed number of observations to sample.
| Minimum value (exclusive) | 0 |
output={SRSOutputStatement}
creates a table on the server that contains the sample output or partition output.
* casOut={casouttable}
specifies the settings for an output table.
caslib="string"
specifies the name of the caslib to use.
compress=TRUE | FALSE
when set to True, data compression is applied to the table.
| Default | FALSE |
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
promote=TRUE | FALSE
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | FALSE |
replace=TRUE | FALSE
when set to True, overwrites an existing table with the same name.
| Default | FALSE |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
* copyVars="ALL" | "ALL_NUMERIC" | {"variable-name-1" <, "variable-name-2", ...>}
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, ALL_MODEL, or ALL_NUMERIC, which respectively copies all variables, all variables used in the modeling, or all numeric variables from the input table to the output table.
partIndName="string"
renames the reserved partition indicator variable, which by default is named _PartInd_ in the output table. This variable indicates whether an observation is selected for the sample (1) or not (0).
| Alias | partName |
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 |
partInd=TRUE | FALSE
when set to True, generates a partition indicator column in the output data table.
| Alias | partition |
| Default | FALSE |
sampPct=double
specifies the sample percentage to be used in sampling or partitioning.
| Range | (0–100] |
sampPct2=double
specifies a second sample percentage to be used to partition data.
| Range | (0–100] |
seed=64-bit-integer
specifies an integer to use to start the pseudorandom number generator.
| Default | 0 |
* 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 that contains the 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.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus 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.
| Alias | options, dataSource |
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
where="where-expression"
specifies an expression for subsetting the input data.
srs Action
Samples a proportion of data from the input table or partitions the data into no more than three portions.
Lua Syntax
Parameter Descriptions
attributes={{casinvardesc-1} <, {casinvardesc-2}, ...>}
changes the attributes of variables used in this action. Currently, attributes specified on the inputs and nominals parameter are ignored.
For more information about specifying the attributes parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | attribute |
diagnostics={_diagnostics}
eyecatcher="string"
specifies a quoted string that will be prefixed to any messages that are associated with this action invocation.
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).
fixedObs=64-bit-integer
specifies a fixed number of observations to sample.
| Minimum value (exclusive) | 0 |
output={SRSOutputStatement}
creates a table on the server that contains the sample output or partition output.
* casOut={casouttable}
specifies the settings for an output table.
caslib="string"
specifies the name of the caslib to use.
compress=true | false
when set to True, data compression is applied to the table.
| Default | false |
indexVars={"variable-name-1" <, "variable-name-2", ...>}
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
promote=true | false
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | false |
replace=true | false
when set to True, overwrites an existing table with the same name.
| Default | false |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where={"string-1" <, "string-2", ...>}
specifies an expression for subsetting the output data.
* copyVars="ALL" | "ALL_NUMERIC" | {"variable-name-1" <, "variable-name-2", ...>}
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, ALL_MODEL, or ALL_NUMERIC, which respectively copies all variables, all variables used in the modeling, or all numeric variables from the input table to the output table.
partIndName="string"
renames the reserved partition indicator variable, which by default is named _PartInd_ in the output table. This variable indicates whether an observation is selected for the sample (1) or not (0).
| Alias | partName |
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 |
partInd=true | false
when set to True, generates a partition indicator column in the output data table.
| Alias | partition |
| Default | false |
sampPct=double
specifies the sample percentage to be used in sampling or partitioning.
| Range | (0–100] |
sampPct2=double
specifies a second sample percentage to be used to partition data.
| Range | (0–100] |
seed=64-bit-integer
specifies an integer to use to start the pseudorandom number generator.
| Default | 0 |
* 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 that contains the 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.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus 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.
| Alias | options, dataSource |
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
singlePass=true | false
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
where="where-expression"
specifies an expression for subsetting the input data.
srs Action
Samples a proportion of data from the input table or partitions the data into no more than three portions.
Python Syntax
Parameter Descriptions
attributes=[{casinvardesc-1} <, {casinvardesc-2}, ...>]
changes the attributes of variables used in this action. Currently, attributes specified on the inputs and nominals parameter are ignored.
For more information about specifying the attributes parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | attribute |
diagnostics={_diagnostics}
"eyecatcher":"string"
specifies a quoted string that will be prefixed to any messages that are associated with this action invocation.
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).
fixedObs=64-bit-integer
specifies a fixed number of observations to sample.
| Minimum value (exclusive) | 0 |
output={SRSOutputStatement}
creates a table on the server that contains the sample output or partition output.
* "casOut":{casouttable}
specifies the settings for an output table.
"caslib":"string"
specifies the name of the caslib to use.
"compress":True | False
when set to True, data compression is applied to the table.
| Default | False |
"indexVars":["variable-name-1" <, "variable-name-2", ...>]
specifies the list of variables to create indexes for in the output data
"label":"string"
specifies the descriptive label to associate with the table.
"maxMemSize":64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
"name":"table-name"
specifies the name to associate with the table.
"promote":True | False
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | False |
"replace":True | False
when set to True, overwrites an existing table with the same name.
| Default | False |
"replication":integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
"timeStamp":"string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
"where":["string-1" <, "string-2", ...>]
specifies an expression for subsetting the output data.
* "copyVars":"ALL" | "ALL_NUMERIC" | ["variable-name-1" <, "variable-name-2", ...>]
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, ALL_MODEL, or ALL_NUMERIC, which respectively copies all variables, all variables used in the modeling, or all numeric variables from the input table to the output table.
"partIndName":"string"
renames the reserved partition indicator variable, which by default is named _PartInd_ in the output table. This variable indicates whether an observation is selected for the sample (1) or not (0).
| Alias | partName |
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 |
partInd=True | False
when set to True, generates a partition indicator column in the output data table.
| Alias | partition |
| Default | False |
sampPct=double
specifies the sample percentage to be used in sampling or partitioning.
| Range | (0–100] |
sampPct2=double
specifies a second sample percentage to be used to partition data.
| Range | (0–100] |
seed=64-bit-integer
specifies an integer to use to start the pseudorandom number generator.
| Default | 0 |
* 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 that contains the 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.
| Alias | compVars |
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus 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.
| Alias | options, dataSource |
"importOptions":{fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* "name":"table-name"
specifies the name of the table to use.
"singlePass":True | False
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
"where":"where-expression"
specifies an expression for subsetting the input data.
srs Action
Samples a proportion of data from the input table or partitions the data into no more than three portions.
R Syntax
Parameter Descriptions
attributes=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
changes the attributes of variables used in this action. Currently, attributes specified on the inputs and nominals parameter are ignored.
For more information about specifying the attributes parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
| Alias | attribute |
diagnostics=list(_diagnostics)
eyecatcher="string"
specifies a quoted string that will be prefixed to any messages that are associated with this action invocation.
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).
fixedObs=64-bit-integer
specifies a fixed number of observations to sample.
| Minimum value (exclusive) | 0 |
output=list(SRSOutputStatement)
creates a table on the server that contains the sample output or partition output.
* casOut=list(casouttable)
specifies the settings for an output table.
caslib="string"
specifies the name of the caslib to use.
compress=TRUE | FALSE
when set to True, data compression is applied to the table.
| Default | FALSE |
indexVars=list("variable-name-1" <, "variable-name-2", ...>)
specifies the list of variables to create indexes for in the output data
label="string"
specifies the descriptive label to associate with the table.
maxMemSize=64-bit-integer
specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.
| TIP | You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes. |
name="table-name"
specifies the name to associate with the table.
promote=TRUE | FALSE
when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.
| Default | FALSE |
replace=TRUE | FALSE
when set to True, overwrites an existing table with the same name.
| Default | FALSE |
replication=integer
specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure.
| Default | 1 |
| Minimum value | 0 |
timeStamp="string"
specifies the timestamp to apply to the table. Specify the value in the form that is appropriate for your session locale.
where=list("string-1" <, "string-2", ...>)
specifies an expression for subsetting the output data.
* copyVars="ALL" | "ALL_NUMERIC" | list("variable-name-1" <, "variable-name-2", ...>)
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, ALL_MODEL, or ALL_NUMERIC, which respectively copies all variables, all variables used in the modeling, or all numeric variables from the input table to the output table.
partIndName="string"
renames the reserved partition indicator variable, which by default is named _PartInd_ in the output table. This variable indicates whether an observation is selected for the sample (1) or not (0).
| Alias | partName |
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 |
partInd=TRUE | FALSE
when set to True, generates a partition indicator column in the output data table.
| Alias | partition |
| Default | FALSE |
sampPct=double
specifies the sample percentage to be used in sampling or partitioning.
| Range | (0–100] |
sampPct2=double
specifies a second sample percentage to be used to partition data.
| Range | (0–100] |
seed=64-bit-integer
specifies an integer to use to start the pseudorandom number generator.
| Default | 0 |
* 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 that contains the 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.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus 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.
| Alias | options, dataSource |
importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
where="where-expression"
specifies an expression for subsetting the input data.