Common Parameter: biomedimageTableIn
CASL Syntax
Parameter Descriptions
bioMedDimension="variable-name"
specifies the name of the image table column containing biomedical image dimensions.
| Default | "IMCORE_BIOMEDDIM_COL_NAME" |
bioMedId="variable-name"
specifies the name of the image table column containing biomedical image identifiers.
| Default | "IMCORE_BIOMEDID_COL_NAME" |
dimension="variable-name"
specifies the name of the image table column containing dimensions of images.
| Default | "_dimension_" |
id="variable-name"
specifies the name of the variable in the input table that identifies each image.
| Default | "_id_" |
image="variable-name"
specifies the name of the image table column containing image binaries.
| Default | "_image_" |
imageFormat="variable-name"
specifies the name of the image table column containing formats of image binaries.
| Default | "_imageFormat_" |
label="variable-name"
specifies the name of the column that contains labels of images.
| Default | "_label_" |
orientation="variable-name"
specifies the name of the image table column containing image orientations.
| Default | "_orientation_" |
path="variable-name"
specifies the name of the image table column containing file paths.
| Default | "_path_" |
position="variable-name"
specifies the name of the image table column containing image positions.
| Default | "_position_" |
resolution="variable-name"
specifies the name of the image table column containing resolutions of images.
| Default | "_resolution_" |
size="variable-name"
specifies the name of the image table column containing byte lengths of image binaries.
| Default | "_size_" |
sliceIndex="variable-name"
specifies the name of the image table column containing slice indices.
| Default | "IMCORE_SLICEINDEX_COL_NAME" |
spacing="variable-name"
specifies the name of the image table column containing image spacings.
| Default | "_spacing_" |
* table={castable}
| 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.
| 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.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
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 |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
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.
where="where-expression"
specifies an expression for subsetting the input data.
type="variable-name"
specifies the name of the image table column containing types (jpg, bmp, etc.) of images.
| Default | "_type_" |
Parameters for fileType="AUTO"
No parameters apply when you specify AUTO
Parameters for fileType="BASESAS"
charMultiplier=double
specifies a multiplier value to expand fixed-width character variables that might require transcoding. The lengths are increased to avoid character data truncation. The lengths are increased by multiplying the length by the specified value.
| Default | 1 |
| Range | 1–5 |
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"
specifies how data is transferred between the data source and SAS Cloud Analytic Services.
| Default | AUTO |
encryptionPassword="string" | binary-large-object
specifies a password for encrypting or decrypting stored data.
password="string"
specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.
read="string"
specifies the Read password for the SAS data set.
varcharConversion=double
specifies the number of bytes to use as a threshold. When a column with the CHAR data type has a length that is equal to or exceeds the specified number of bytes, the VARCHAR data type is used.
| Default | 0 |
| Range | 1–32767 |
Parameters for fileType="CSV"
allowTruncation=TRUE | FALSE
specifies that truncation of character data that is too long for a given field is allowed.
| Default | TRUE |
delimiter="string"
specifies the character to use as the field delimiter.
| Default | "," |
encoding="string"
specifies the text encoding of the file. If you do not specify this parameter, then the session encoding is used.
| Default | "utf-8" |
getNames=TRUE | FALSE
when set to True, the values in the first line of the file are used as variable names.
| Default | TRUE |
guessRows=64-bit-integer
specifies the number of rows to scan in order to determine data types for variables.
| Default | 20 |
| Minimum value | 1 |
locale="string"
specifies the locale for interpreting data in the file
nThreads=integer
specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.
| Default | 0 |
| Minimum value | 0 |
stripBlanks=TRUE | FALSE
removes leading and trailing blanks from character variables.
| Default | FALSE |
varChars=TRUE | FALSE
when set to True, variable-length strings are used for character variables.
| Default | TRUE |
vars={{casvarcsvdesc-1} <, {casvarcsvdesc-2}, ...>}
specifies the names, types, formats, and other metadata for variables.
| The casvarcsvdesc 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 format field plus the format precision.
informat="string"
specifies the informat to apply to the variable.
label="string"
specifies the descriptive label for the variable.
length=integer
specifies the unformatted length of the variable. This parameter applies to fixed-length character variables (type="CHAR") only.
| Default | 8 |
| Minimum value | 1 |
name="string"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
specifies the data type for the variable.
| Default | DOUBLE |
Parameters for fileType="DOCUMENT"
fileExtList={"CSV", "DOC", "DOCX", "EPUB", "HTML", "KEY", "MBOX", "MSG", "NUMBERS", "ODP", "ODS", "ODT", "PAGES", "PDF", "PPT", "PPTX", "PST", "RTF", "TNEF", "TXT", "WPD", "XLS", "XLSX", "XML"}
specifies the file extensions for subsetting document selection.
recurse=TRUE | FALSE
recursively import documents when the caslib definition permits access to subdirectories.
| Default | TRUE |
tikaConv=TRUE | FALSE
specifies to convert the documents with the Apache Tika document conversion library.
| Default | FALSE |
Parameters for fileType="DTA"
No parameters apply when you specify DTA
Parameters for fileType="ESP"
maxTime=integer
specifies the number of seconds to receive data from SAS Event Stream Processing before declaring an end of file on the stream. The data is read until an end of file is found, and then the action stops running.
| Default | 5 |
sasTypes=TRUE | FALSE
when set to True, the table is created with character and float data types only. When set to False, the table uses the same data types that are used in the ESP event.
| Default | FALSE |
Parameters for fileType="EXCEL"
getNames=TRUE | FALSE
when set to True, the values in the first line of the file are used as variable names.
| Default | TRUE |
range="string"
specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.
sheet="string"
specifies the name of the worksheet to import.
Parameters for fileType="FMT"
name="string"
specifies a file system path and filename. The file must be a SAS item store that includes the formats to import.
Parameters for fileType="HDAT"
encryptionPassword="string" | binary-large-object
specifies a password for encrypting or decrypting stored data.
Parameters for fileType="JMP"
No parameters apply when you specify JMP
Parameters for fileType="LASR"
compPgm="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
compVars={"string-1" <, "string-2", ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
nThreads=integer
specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.
| Default | 0 |
| Minimum value | 0 |
parallelMode="FALLBACK" | "FORCE" | "NONE"
specifies how the table is transferred from SAS LASR Analytic Server to SAS Cloud Analytic Services.
| Default | FALLBACK |
FALLBACK
specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.
preserveOrder=TRUE | FALSE
when set to True, the rows are inserted into the new table in the same order as they are received from the SAS LASR Analytic Server. Creating the table is less efficient when this parameter is used.
| Default | FALSE |
varchars=TRUE | FALSE
when set to True, variable-length strings are used for character variables.
| Default | FALSE |
vars={"string-1" <, "string-2", ...>}
specifies the variables to use in the action.
where="where-expression"
specifies an expression for subsetting the input data.
Parameters for fileType="SPSS"
No parameters apply when you specify SPSS
Parameters for fileType="XLS"
getNames=TRUE | FALSE
when set to True, the values in the first line of the file are used as variable names.
| Default | TRUE |
range="string"
specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.
sheet="string"
specifies the name of the worksheet to import.
Lua Syntax
Parameter Descriptions
bioMedDimension="variable-name"
specifies the name of the image table column containing biomedical image dimensions.
| Default | "IMCORE_BIOMEDDIM_COL_NAME" |
bioMedId="variable-name"
specifies the name of the image table column containing biomedical image identifiers.
| Default | "IMCORE_BIOMEDID_COL_NAME" |
dimension="variable-name"
specifies the name of the image table column containing dimensions of images.
| Default | "_dimension_" |
id="variable-name"
specifies the name of the variable in the input table that identifies each image.
| Default | "_id_" |
image="variable-name"
specifies the name of the image table column containing image binaries.
| Default | "_image_" |
imageFormat="variable-name"
specifies the name of the image table column containing formats of image binaries.
| Default | "_imageFormat_" |
label="variable-name"
specifies the name of the column that contains labels of images.
| Default | "_label_" |
orientation="variable-name"
specifies the name of the image table column containing image orientations.
| Default | "_orientation_" |
path="variable-name"
specifies the name of the image table column containing file paths.
| Default | "_path_" |
position="variable-name"
specifies the name of the image table column containing image positions.
| Default | "_position_" |
resolution="variable-name"
specifies the name of the image table column containing resolutions of images.
| Default | "_resolution_" |
size="variable-name"
specifies the name of the image table column containing byte lengths of image binaries.
| Default | "_size_" |
sliceIndex="variable-name"
specifies the name of the image table column containing slice indices.
| Default | "IMCORE_SLICEINDEX_COL_NAME" |
spacing="variable-name"
specifies the name of the image table column containing image spacings.
| Default | "_spacing_" |
* table={castable}
| 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.
| 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.
onDemand=true | false
This parameter is deprecated.
| Default | true |
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 |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
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.
where="where-expression"
specifies an expression for subsetting the input data.
type="variable-name"
specifies the name of the image table column containing types (jpg, bmp, etc.) of images.
| Default | "_type_" |
Parameters for fileType="AUTO"
No parameters apply when you specify AUTO
Parameters for fileType="BASESAS"
charMultiplier=double
specifies a multiplier value to expand fixed-width character variables that might require transcoding. The lengths are increased to avoid character data truncation. The lengths are increased by multiplying the length by the specified value.
| Default | 1 |
| Range | 1–5 |
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"
specifies how data is transferred between the data source and SAS Cloud Analytic Services.
| Default | AUTO |
encryptionPassword="string" | binary-large-object
specifies a password for encrypting or decrypting stored data.
password="string"
specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.
read="string"
specifies the Read password for the SAS data set.
varcharConversion=double
specifies the number of bytes to use as a threshold. When a column with the CHAR data type has a length that is equal to or exceeds the specified number of bytes, the VARCHAR data type is used.
| Default | 0 |
| Range | 1–32767 |
Parameters for fileType="CSV"
allowTruncation=true | false
specifies that truncation of character data that is too long for a given field is allowed.
| Default | true |
delimiter="string"
specifies the character to use as the field delimiter.
| Default | "," |
encoding="string"
specifies the text encoding of the file. If you do not specify this parameter, then the session encoding is used.
| Default | "utf-8" |
getNames=true | false
when set to True, the values in the first line of the file are used as variable names.
| Default | true |
guessRows=64-bit-integer
specifies the number of rows to scan in order to determine data types for variables.
| Default | 20 |
| Minimum value | 1 |
locale="string"
specifies the locale for interpreting data in the file
nThreads=integer
specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.
| Default | 0 |
| Minimum value | 0 |
stripBlanks=true | false
removes leading and trailing blanks from character variables.
| Default | false |
varChars=true | false
when set to True, variable-length strings are used for character variables.
| Default | true |
vars={{casvarcsvdesc-1} <, {casvarcsvdesc-2}, ...>}
specifies the names, types, formats, and other metadata for variables.
| The casvarcsvdesc 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 format field plus the format precision.
informat="string"
specifies the informat to apply to the variable.
label="string"
specifies the descriptive label for the variable.
length=integer
specifies the unformatted length of the variable. This parameter applies to fixed-length character variables (type="CHAR") only.
| Default | 8 |
| Minimum value | 1 |
name="string"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
specifies the data type for the variable.
| Default | DOUBLE |
Parameters for fileType="DOCUMENT"
fileExtList={"CSV", "DOC", "DOCX", "EPUB", "HTML", "KEY", "MBOX", "MSG", "NUMBERS", "ODP", "ODS", "ODT", "PAGES", "PDF", "PPT", "PPTX", "PST", "RTF", "TNEF", "TXT", "WPD", "XLS", "XLSX", "XML"}
specifies the file extensions for subsetting document selection.
recurse=true | false
recursively import documents when the caslib definition permits access to subdirectories.
| Default | true |
tikaConv=true | false
specifies to convert the documents with the Apache Tika document conversion library.
| Default | false |
Parameters for fileType="DTA"
No parameters apply when you specify DTA
Parameters for fileType="ESP"
maxTime=integer
specifies the number of seconds to receive data from SAS Event Stream Processing before declaring an end of file on the stream. The data is read until an end of file is found, and then the action stops running.
| Default | 5 |
sasTypes=true | false
when set to True, the table is created with character and float data types only. When set to False, the table uses the same data types that are used in the ESP event.
| Default | false |
Parameters for fileType="EXCEL"
getNames=true | false
when set to True, the values in the first line of the file are used as variable names.
| Default | true |
range="string"
specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.
sheet="string"
specifies the name of the worksheet to import.
Parameters for fileType="FMT"
name="string"
specifies a file system path and filename. The file must be a SAS item store that includes the formats to import.
Parameters for fileType="HDAT"
encryptionPassword="string" | binary-large-object
specifies a password for encrypting or decrypting stored data.
Parameters for fileType="JMP"
No parameters apply when you specify JMP
Parameters for fileType="LASR"
compPgm="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
compVars={"string-1" <, "string-2", ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
nThreads=integer
specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.
| Default | 0 |
| Minimum value | 0 |
parallelMode="FALLBACK" | "FORCE" | "NONE"
specifies how the table is transferred from SAS LASR Analytic Server to SAS Cloud Analytic Services.
| Default | FALLBACK |
FALLBACK
specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.
preserveOrder=true | false
when set to True, the rows are inserted into the new table in the same order as they are received from the SAS LASR Analytic Server. Creating the table is less efficient when this parameter is used.
| Default | false |
varchars=true | false
when set to True, variable-length strings are used for character variables.
| Default | false |
vars={"string-1" <, "string-2", ...>}
specifies the variables to use in the action.
where="where-expression"
specifies an expression for subsetting the input data.
Parameters for fileType="SPSS"
No parameters apply when you specify SPSS
Parameters for fileType="XLS"
getNames=true | false
when set to True, the values in the first line of the file are used as variable names.
| Default | true |
range="string"
specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.
sheet="string"
specifies the name of the worksheet to import.
Python Syntax
Parameter Descriptions
"bioMedDimension":"variable-name"
specifies the name of the image table column containing biomedical image dimensions.
| Default | "IMCORE_BIOMEDDIM_COL_NAME" |
"bioMedId":"variable-name"
specifies the name of the image table column containing biomedical image identifiers.
| Default | "IMCORE_BIOMEDID_COL_NAME" |
"dimension":"variable-name"
specifies the name of the image table column containing dimensions of images.
| Default | "_dimension_" |
"id":"variable-name"
specifies the name of the variable in the input table that identifies each image.
| Default | "_id_" |
"image":"variable-name"
specifies the name of the image table column containing image binaries.
| Default | "_image_" |
"imageFormat":"variable-name"
specifies the name of the image table column containing formats of image binaries.
| Default | "_imageFormat_" |
"label":"variable-name"
specifies the name of the column that contains labels of images.
| Default | "_label_" |
"orientation":"variable-name"
specifies the name of the image table column containing image orientations.
| Default | "_orientation_" |
"path":"variable-name"
specifies the name of the image table column containing file paths.
| Default | "_path_" |
"position":"variable-name"
specifies the name of the image table column containing image positions.
| Default | "_position_" |
"resolution":"variable-name"
specifies the name of the image table column containing resolutions of images.
| Default | "_resolution_" |
"size":"variable-name"
specifies the name of the image table column containing byte lengths of image binaries.
| Default | "_size_" |
"sliceIndex":"variable-name"
specifies the name of the image table column containing slice indices.
| Default | "IMCORE_SLICEINDEX_COL_NAME" |
"spacing":"variable-name"
specifies the name of the image table column containing image spacings.
| Default | "_spacing_" |
* "table":{castable}
| 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.
| 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.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
"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 |
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use in the action.
"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.
"where":"where-expression"
specifies an expression for subsetting the input data.
"type":"variable-name"
specifies the name of the image table column containing types (jpg, bmp, etc.) of images.
| Default | "_type_" |
Parameters for fileType="AUTO"
No parameters apply when you specify AUTO
Parameters for fileType="BASESAS"
"charMultiplier":double
specifies a multiplier value to expand fixed-width character variables that might require transcoding. The lengths are increased to avoid character data truncation. The lengths are increased by multiplying the length by the specified value.
| Default | 1 |
| Range | 1–5 |
"dataTransferMode":"AUTO" | "PARALLEL" | "SERIAL"
specifies how data is transferred between the data source and SAS Cloud Analytic Services.
| Default | AUTO |
"encryptionPassword":"string" | binary-large-object
specifies a password for encrypting or decrypting stored data.
"password":"string"
specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.
"read":"string"
specifies the Read password for the SAS data set.
"varcharConversion":double
specifies the number of bytes to use as a threshold. When a column with the CHAR data type has a length that is equal to or exceeds the specified number of bytes, the VARCHAR data type is used.
| Default | 0 |
| Range | 1–32767 |
Parameters for fileType="CSV"
"allowTruncation":True | False
specifies that truncation of character data that is too long for a given field is allowed.
| Default | True |
"delimiter":"string"
specifies the character to use as the field delimiter.
| Default | "," |
"encoding":"string"
specifies the text encoding of the file. If you do not specify this parameter, then the session encoding is used.
| Default | "utf-8" |
"getNames":True | False
when set to True, the values in the first line of the file are used as variable names.
| Default | True |
"guessRows":64-bit-integer
specifies the number of rows to scan in order to determine data types for variables.
| Default | 20 |
| Minimum value | 1 |
"locale":"string"
specifies the locale for interpreting data in the file
"nThreads":integer
specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.
| Default | 0 |
| Minimum value | 0 |
"stripBlanks":True | False
removes leading and trailing blanks from character variables.
| Default | False |
"varChars":True | False
when set to True, variable-length strings are used for character variables.
| Default | True |
"vars":[{casvarcsvdesc-1} <, {casvarcsvdesc-2}, ...>]
specifies the names, types, formats, and other metadata for variables.
| The casvarcsvdesc 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 format field plus the format precision.
"informat":"string"
specifies the informat to apply to the variable.
"label":"string"
specifies the descriptive label for the variable.
"length":integer
specifies the unformatted length of the variable. This parameter applies to fixed-length character variables (type="CHAR") only.
| Default | 8 |
| Minimum value | 1 |
"name":"string"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"type":"BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
specifies the data type for the variable.
| Default | DOUBLE |
Parameters for fileType="DOCUMENT"
"fileExtList":["CSV", "DOC", "DOCX", "EPUB", "HTML", "KEY", "MBOX", "MSG", "NUMBERS", "ODP", "ODS", "ODT", "PAGES", "PDF", "PPT", "PPTX", "PST", "RTF", "TNEF", "TXT", "WPD", "XLS", "XLSX", "XML"]
specifies the file extensions for subsetting document selection.
"recurse":True | False
recursively import documents when the caslib definition permits access to subdirectories.
| Default | True |
"tikaConv":True | False
specifies to convert the documents with the Apache Tika document conversion library.
| Default | False |
Parameters for fileType="DTA"
No parameters apply when you specify DTA
Parameters for fileType="ESP"
"maxTime":integer
specifies the number of seconds to receive data from SAS Event Stream Processing before declaring an end of file on the stream. The data is read until an end of file is found, and then the action stops running.
| Default | 5 |
"sasTypes":True | False
when set to True, the table is created with character and float data types only. When set to False, the table uses the same data types that are used in the ESP event.
| Default | False |
Parameters for fileType="EXCEL"
"getNames":True | False
when set to True, the values in the first line of the file are used as variable names.
| Default | True |
"range":"string"
specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.
"sheet":"string"
specifies the name of the worksheet to import.
Parameters for fileType="FMT"
"name":"string"
specifies a file system path and filename. The file must be a SAS item store that includes the formats to import.
Parameters for fileType="HDAT"
"encryptionPassword":"string" | binary-large-object
specifies a password for encrypting or decrypting stored data.
Parameters for fileType="JMP"
No parameters apply when you specify JMP
Parameters for fileType="LASR"
"compPgm":"string"
specifies an expression for each computed variable that you include in the computedVars parameter.
"compVars":["string-1" <, "string-2", ...>]
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
"nThreads":integer
specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.
| Default | 0 |
| Minimum value | 0 |
"parallelMode":"FALLBACK" | "FORCE" | "NONE"
specifies how the table is transferred from SAS LASR Analytic Server to SAS Cloud Analytic Services.
| Default | FALLBACK |
FALLBACK
specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.
"preserveOrder":True | False
when set to True, the rows are inserted into the new table in the same order as they are received from the SAS LASR Analytic Server. Creating the table is less efficient when this parameter is used.
| Default | False |
"varchars":True | False
when set to True, variable-length strings are used for character variables.
| Default | False |
"vars":["string-1" <, "string-2", ...>]
specifies the variables to use in the action.
"where":"where-expression"
specifies an expression for subsetting the input data.
Parameters for fileType="SPSS"
No parameters apply when you specify SPSS
Parameters for fileType="XLS"
"getNames":True | False
when set to True, the values in the first line of the file are used as variable names.
| Default | True |
"range":"string"
specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.
"sheet":"string"
specifies the name of the worksheet to import.
R Syntax
Parameter Descriptions
bioMedDimension="variable-name"
specifies the name of the image table column containing biomedical image dimensions.
| Default | "IMCORE_BIOMEDDIM_COL_NAME" |
bioMedId="variable-name"
specifies the name of the image table column containing biomedical image identifiers.
| Default | "IMCORE_BIOMEDID_COL_NAME" |
dimension="variable-name"
specifies the name of the image table column containing dimensions of images.
| Default | "_dimension_" |
id="variable-name"
specifies the name of the variable in the input table that identifies each image.
| Default | "_id_" |
image="variable-name"
specifies the name of the image table column containing image binaries.
| Default | "_image_" |
imageFormat="variable-name"
specifies the name of the image table column containing formats of image binaries.
| Default | "_imageFormat_" |
label="variable-name"
specifies the name of the column that contains labels of images.
| Default | "_label_" |
orientation="variable-name"
specifies the name of the image table column containing image orientations.
| Default | "_orientation_" |
path="variable-name"
specifies the name of the image table column containing file paths.
| Default | "_path_" |
position="variable-name"
specifies the name of the image table column containing image positions.
| Default | "_position_" |
resolution="variable-name"
specifies the name of the image table column containing resolutions of images.
| Default | "_resolution_" |
size="variable-name"
specifies the name of the image table column containing byte lengths of image binaries.
| Default | "_size_" |
sliceIndex="variable-name"
specifies the name of the image table column containing slice indices.
| Default | "IMCORE_SLICEINDEX_COL_NAME" |
spacing="variable-name"
specifies the name of the image table column containing image spacings.
| Default | "_spacing_" |
* table=list(castable)
| 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.
| 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.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
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 |
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use in the action.
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.
where="where-expression"
specifies an expression for subsetting the input data.
type="variable-name"
specifies the name of the image table column containing types (jpg, bmp, etc.) of images.
| Default | "_type_" |
Parameters for fileType="AUTO"
No parameters apply when you specify AUTO
Parameters for fileType="BASESAS"
charMultiplier=double
specifies a multiplier value to expand fixed-width character variables that might require transcoding. The lengths are increased to avoid character data truncation. The lengths are increased by multiplying the length by the specified value.
| Default | 1 |
| Range | 1–5 |
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"
specifies how data is transferred between the data source and SAS Cloud Analytic Services.
| Default | AUTO |
encryptionPassword="string" | binary-large-object
specifies a password for encrypting or decrypting stored data.
password="string"
specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.
read="string"
specifies the Read password for the SAS data set.
varcharConversion=double
specifies the number of bytes to use as a threshold. When a column with the CHAR data type has a length that is equal to or exceeds the specified number of bytes, the VARCHAR data type is used.
| Default | 0 |
| Range | 1–32767 |
Parameters for fileType="CSV"
allowTruncation=TRUE | FALSE
specifies that truncation of character data that is too long for a given field is allowed.
| Default | TRUE |
delimiter="string"
specifies the character to use as the field delimiter.
| Default | "," |
encoding="string"
specifies the text encoding of the file. If you do not specify this parameter, then the session encoding is used.
| Default | "utf-8" |
getNames=TRUE | FALSE
when set to True, the values in the first line of the file are used as variable names.
| Default | TRUE |
guessRows=64-bit-integer
specifies the number of rows to scan in order to determine data types for variables.
| Default | 20 |
| Minimum value | 1 |
locale="string"
specifies the locale for interpreting data in the file
nThreads=integer
specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.
| Default | 0 |
| Minimum value | 0 |
stripBlanks=TRUE | FALSE
removes leading and trailing blanks from character variables.
| Default | FALSE |
varChars=TRUE | FALSE
when set to True, variable-length strings are used for character variables.
| Default | TRUE |
vars=list( list(casvarcsvdesc-1) <, list(casvarcsvdesc-2), ...>)
specifies the names, types, formats, and other metadata for variables.
| The casvarcsvdesc 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 format field plus the format precision.
informat="string"
specifies the informat to apply to the variable.
label="string"
specifies the descriptive label for the variable.
length=integer
specifies the unformatted length of the variable. This parameter applies to fixed-length character variables (type="CHAR") only.
| Default | 8 |
| Minimum value | 1 |
name="string"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"
specifies the data type for the variable.
| Default | DOUBLE |
Parameters for fileType="DOCUMENT"
fileExtList=list("CSV", "DOC", "DOCX", "EPUB", "HTML", "KEY", "MBOX", "MSG", "NUMBERS", "ODP", "ODS", "ODT", "PAGES", "PDF", "PPT", "PPTX", "PST", "RTF", "TNEF", "TXT", "WPD", "XLS", "XLSX", "XML")
specifies the file extensions for subsetting document selection.
recurse=TRUE | FALSE
recursively import documents when the caslib definition permits access to subdirectories.
| Default | TRUE |
tikaConv=TRUE | FALSE
specifies to convert the documents with the Apache Tika document conversion library.
| Default | FALSE |
Parameters for fileType="DTA"
No parameters apply when you specify DTA
Parameters for fileType="ESP"
maxTime=integer
specifies the number of seconds to receive data from SAS Event Stream Processing before declaring an end of file on the stream. The data is read until an end of file is found, and then the action stops running.
| Default | 5 |
sasTypes=TRUE | FALSE
when set to True, the table is created with character and float data types only. When set to False, the table uses the same data types that are used in the ESP event.
| Default | FALSE |
Parameters for fileType="EXCEL"
getNames=TRUE | FALSE
when set to True, the values in the first line of the file are used as variable names.
| Default | TRUE |
range="string"
specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.
sheet="string"
specifies the name of the worksheet to import.
Parameters for fileType="FMT"
name="string"
specifies a file system path and filename. The file must be a SAS item store that includes the formats to import.
Parameters for fileType="HDAT"
encryptionPassword="string" | binary-large-object
specifies a password for encrypting or decrypting stored data.
Parameters for fileType="JMP"
No parameters apply when you specify JMP
Parameters for fileType="LASR"
compPgm="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
compVars=list("string-1" <, "string-2", ...>)
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
nThreads=integer
specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.
| Default | 0 |
| Minimum value | 0 |
parallelMode="FALLBACK" | "FORCE" | "NONE"
specifies how the table is transferred from SAS LASR Analytic Server to SAS Cloud Analytic Services.
| Default | FALLBACK |
FALLBACK
specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.
preserveOrder=TRUE | FALSE
when set to True, the rows are inserted into the new table in the same order as they are received from the SAS LASR Analytic Server. Creating the table is less efficient when this parameter is used.
| Default | FALSE |
varchars=TRUE | FALSE
when set to True, variable-length strings are used for character variables.
| Default | FALSE |
vars=list("string-1" <, "string-2", ...>)
specifies the variables to use in the action.
where="where-expression"
specifies an expression for subsetting the input data.
Parameters for fileType="SPSS"
No parameters apply when you specify SPSS
Parameters for fileType="XLS"
getNames=TRUE | FALSE
when set to True, the values in the first line of the file are used as variable names.
| Default | TRUE |
range="string"
specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.
sheet="string"
specifies the name of the worksheet to import.