Text Mining Action Set: Syntax
Provides actions for mining textual data
tmSvd Action
Computes the SVD factorization and generates topics. This action requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
CASL Syntax
Parameter Descriptions
config={castable}
specifies the name of the input CAS table that contains parsing configuration information
| Alias | parseConfig |
| Long form | config={name="table-name"} |
| Shortcut form | config="table-name" |
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 |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
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.
groupByMode="NOSORT" | "REDISTRIBUTE"
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 |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
count="variable-name"
specifies the variable that contains the, possibly weighted, term count. The values in this variable must be numeric. There can be no missing values in this variable.
| Default | "_COUNT_" |
docId="variable-name"
specifies the variable that contains the document ID. The type of this variable can either be numeric or a string. There can be no missing values in this variable.
| Default | "_DOCUMENT_" |
docPro={casouttable}
specifies the name of the table to contain the SVD projections of the documents.
For more information about specifying the docPro parameter, see the common casouttable parameter (Appendix A: Common Parameters).
docStdMultiple=double
Specifies how many standard deviations above the mean to set the document cutoff. This parameter requires a SAS Visual Text Analytics license.
| Default | 1 |
| Range | 0–10 |
exactDocPro=TRUE | FALSE
Specifies if the exact document projection values should be output. This parameter requires a SAS Visual Text Analytics license.
| Default | TRUE |
exactWeight=TRUE | FALSE
| Alias | exactWeights |
| Default | FALSE |
k=integer
specifies the number of dimensions to be extracted (also the number of derived topics). If the input data is too small for the requested number of dimensions, this value is adjusted to complete the calculation.
| Alias | numTopics |
| Range | 1–1000 |
legacyNames=TRUE | FALSE
specifies whether to use the legacy variable names on tables. This parameter requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
| Default | FALSE |
maxK=integer
specifies the maximum number of dimensions to be extracted. The maxK option can be used in conjunction with the resolution option to dynamically select the recommended number of dimensions. If you wish to use a specific number of dimensions use maxK and set the resolution to high, or use the k parameter.
| Default | 10 |
| Range | 1–1000 |
nThreads=integer
specifies number of threads to be used per node. If not set, or if a value of 0 is specified, all available threads will be used.
| Default | 8 |
| Range | 0–64 |
norm="ALL" | "DOC" | "NONE" | "WORD"
indicates whether the document projections, term projections, or both are normalized. The normalization converts the representation from depending on angles between vectors to one based on Euclidean distances between vectors.
| Default | ALL |
numLabels=integer
specifies the number of terms to use in the descriptive label for each topic.
| Default | 5 |
| Range | 1–500 |
* parent={castable}
specifies the input CAS table that contains the term-by-document matrix in transaction form. The table must have at last three variables, one containing the document id, a second containing the term id, and the third containing the value in the cell corresponding to that particular term and document.
| Long form | parent={name="table-name"} |
| Shortcut form | parent="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 |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
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.
groupByMode="NOSORT" | "REDISTRIBUTE"
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 |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
resolution="HIGH" | "LOW" | "MED"
specifies the desired resolution level for the recommended number of dimensions to be extracted by the SVD.
| Default | HIGH |
rotate="PROMAX" | "VARIMAX"
specifies the type of rotation used to maximize the explanatory power of each topic. A VARIMAX rotation produces uncorrelated topics and a PROMAX rotation produces correlated topics.
| Default | VARIMAX |
rowPivot=double
Specifies the row pivot weight for document normalization of the parent table before the SVD. A negative value turns off the rowPivot process. When topics are requested a rowPivot=1 value is used by default. This parameter requires a SAS Visual Text Analytics license.
| Default | -1 |
| Range | -1–1 |
s={casouttable}
specifies the S matrix, which is a diagonal matrix that is output in compressed form, with two variables and k rows. The variable _ID_ indicates the row and column of the entry and the variable S contains the singular values.
For more information about specifying the s parameter, see the common casouttable parameter (Appendix A: Common Parameters).
scoreConfig={casouttable}
Specifies the output scoring config file.
For more information about specifying the scoreConfig parameter, see the common casouttable parameter (Appendix A: Common Parameters).
termId="variable-name"
specifies the variable that contains the term ID. The contents of this variable must be an integer greater than or equal to 1. There can be no missing values in this variable.
| Default | "_TERMNUM_" |
termStdMultiple=double
Specifies how many standard deviations above the mean to set the term cutoff. This parameter requires a SAS Visual Text Analytics license.
| Default | 1 |
| Range | 0–10 |
termTopics={casouttable}
specifies the name of the output CAS table to contain the term-by-topic sparse matrix information.
For more information about specifying the termTopics parameter, see the common casouttable parameter (Appendix A: Common Parameters).
terms={castable}
specifies the name of the input table that contains information about the terms in the document collection. The table is used to determine which terms to use in the topic calculation.
| Long form | terms={name="table-name"} |
| Shortcut form | terms="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 |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
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.
groupByMode="NOSORT" | "REDISTRIBUTE"
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 |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
tolerance=double
specifies the stopping threshold for the iterative factorization algorithm. If 0 is specified the default value is used.
| Default | 1e-06 |
| Range | 0–1 |
topicDecision=TRUE | FALSE
Specifies to include topic membership decisions and document cutoffs in the output tables. This parameter requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
| Default | FALSE |
topics={casouttable}
specifies the output CAS table to contain the topics that are discovered.
For more information about specifying the topics parameter, see the common casouttable parameter (Appendix A: Common Parameters).
u={casouttable}
specifies the U matrix, which contains the left singular vectors. The matrix U is number of terms by k+1.
For more information about specifying the u parameter, see the common casouttable parameter (Appendix A: Common Parameters).
v={casouttable}
specifies the transpose of the matrix containing the right singular vectors. The matrix V is number of documents by k+1.
For more information about specifying the v parameter, see the common casouttable parameter (Appendix A: Common Parameters).
wordPro={casouttable}
specifies the table to contain the projections of the terms. If k dimensions of the SVD are found and the input data set contains n terms, this table will have n rows and k+1 columns.
For more information about specifying the wordPro parameter, see the common casouttable parameter (Appendix A: Common Parameters).
tmSvd Action
Computes the SVD factorization and generates topics. This action requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
Lua Syntax
Parameter Descriptions
config={castable}
specifies the name of the input CAS table that contains parsing configuration information
| Alias | parseConfig |
| Long form | config={name="table-name"} |
| Shortcut form | config="table-name" |
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 |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
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.
groupByMode="NOSORT" | "REDISTRIBUTE"
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 |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
count="variable-name"
specifies the variable that contains the, possibly weighted, term count. The values in this variable must be numeric. There can be no missing values in this variable.
| Default | "_COUNT_" |
docId="variable-name"
specifies the variable that contains the document ID. The type of this variable can either be numeric or a string. There can be no missing values in this variable.
| Default | "_DOCUMENT_" |
docPro={casouttable}
specifies the name of the table to contain the SVD projections of the documents.
For more information about specifying the docPro parameter, see the common casouttable parameter (Appendix A: Common Parameters).
docStdMultiple=double
Specifies how many standard deviations above the mean to set the document cutoff. This parameter requires a SAS Visual Text Analytics license.
| Default | 1 |
| Range | 0–10 |
exactDocPro=true | false
Specifies if the exact document projection values should be output. This parameter requires a SAS Visual Text Analytics license.
| Default | true |
exactWeight=true | false
| Alias | exactWeights |
| Default | false |
k=integer
specifies the number of dimensions to be extracted (also the number of derived topics). If the input data is too small for the requested number of dimensions, this value is adjusted to complete the calculation.
| Alias | numTopics |
| Range | 1–1000 |
legacyNames=true | false
specifies whether to use the legacy variable names on tables. This parameter requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
| Default | false |
maxK=integer
specifies the maximum number of dimensions to be extracted. The maxK option can be used in conjunction with the resolution option to dynamically select the recommended number of dimensions. If you wish to use a specific number of dimensions use maxK and set the resolution to high, or use the k parameter.
| Default | 10 |
| Range | 1–1000 |
nThreads=integer
specifies number of threads to be used per node. If not set, or if a value of 0 is specified, all available threads will be used.
| Default | 8 |
| Range | 0–64 |
norm="ALL" | "DOC" | "NONE" | "WORD"
indicates whether the document projections, term projections, or both are normalized. The normalization converts the representation from depending on angles between vectors to one based on Euclidean distances between vectors.
| Default | ALL |
numLabels=integer
specifies the number of terms to use in the descriptive label for each topic.
| Default | 5 |
| Range | 1–500 |
* parent={castable}
specifies the input CAS table that contains the term-by-document matrix in transaction form. The table must have at last three variables, one containing the document id, a second containing the term id, and the third containing the value in the cell corresponding to that particular term and document.
| Long form | parent={name="table-name"} |
| Shortcut form | parent="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 |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
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.
groupByMode="NOSORT" | "REDISTRIBUTE"
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 |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
resolution="HIGH" | "LOW" | "MED"
specifies the desired resolution level for the recommended number of dimensions to be extracted by the SVD.
| Default | HIGH |
rotate="PROMAX" | "VARIMAX"
specifies the type of rotation used to maximize the explanatory power of each topic. A VARIMAX rotation produces uncorrelated topics and a PROMAX rotation produces correlated topics.
| Default | VARIMAX |
rowPivot=double
Specifies the row pivot weight for document normalization of the parent table before the SVD. A negative value turns off the rowPivot process. When topics are requested a rowPivot=1 value is used by default. This parameter requires a SAS Visual Text Analytics license.
| Default | -1 |
| Range | -1–1 |
s={casouttable}
specifies the S matrix, which is a diagonal matrix that is output in compressed form, with two variables and k rows. The variable _ID_ indicates the row and column of the entry and the variable S contains the singular values.
For more information about specifying the s parameter, see the common casouttable parameter (Appendix A: Common Parameters).
scoreConfig={casouttable}
Specifies the output scoring config file.
For more information about specifying the scoreConfig parameter, see the common casouttable parameter (Appendix A: Common Parameters).
termId="variable-name"
specifies the variable that contains the term ID. The contents of this variable must be an integer greater than or equal to 1. There can be no missing values in this variable.
| Default | "_TERMNUM_" |
termStdMultiple=double
Specifies how many standard deviations above the mean to set the term cutoff. This parameter requires a SAS Visual Text Analytics license.
| Default | 1 |
| Range | 0–10 |
termTopics={casouttable}
specifies the name of the output CAS table to contain the term-by-topic sparse matrix information.
For more information about specifying the termTopics parameter, see the common casouttable parameter (Appendix A: Common Parameters).
terms={castable}
specifies the name of the input table that contains information about the terms in the document collection. The table is used to determine which terms to use in the topic calculation.
| Long form | terms={name="table-name"} |
| Shortcut form | terms="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 |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
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.
groupByMode="NOSORT" | "REDISTRIBUTE"
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 |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
tolerance=double
specifies the stopping threshold for the iterative factorization algorithm. If 0 is specified the default value is used.
| Default | 1e-06 |
| Range | 0–1 |
topicDecision=true | false
Specifies to include topic membership decisions and document cutoffs in the output tables. This parameter requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
| Default | false |
topics={casouttable}
specifies the output CAS table to contain the topics that are discovered.
For more information about specifying the topics parameter, see the common casouttable parameter (Appendix A: Common Parameters).
u={casouttable}
specifies the U matrix, which contains the left singular vectors. The matrix U is number of terms by k+1.
For more information about specifying the u parameter, see the common casouttable parameter (Appendix A: Common Parameters).
v={casouttable}
specifies the transpose of the matrix containing the right singular vectors. The matrix V is number of documents by k+1.
For more information about specifying the v parameter, see the common casouttable parameter (Appendix A: Common Parameters).
wordPro={casouttable}
specifies the table to contain the projections of the terms. If k dimensions of the SVD are found and the input data set contains n terms, this table will have n rows and k+1 columns.
For more information about specifying the wordPro parameter, see the common casouttable parameter (Appendix A: Common Parameters).
tmSvd Action
Computes the SVD factorization and generates topics. This action requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
Python Syntax
Parameter Descriptions
config={castable}
specifies the name of the input CAS table that contains parsing configuration information
| Alias | parseConfig |
| Long form | config={"name":"table-name"} |
| Shortcut form | config="table-name" |
"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 |
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the variables to use for grouping results.
"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.
"groupByMode":"NOSORT" | "REDISTRIBUTE"
"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 |
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"where":"where-expression"
specifies an expression for subsetting the input data.
count="variable-name"
specifies the variable that contains the, possibly weighted, term count. The values in this variable must be numeric. There can be no missing values in this variable.
| Default | "_COUNT_" |
docId="variable-name"
specifies the variable that contains the document ID. The type of this variable can either be numeric or a string. There can be no missing values in this variable.
| Default | "_DOCUMENT_" |
docPro={casouttable}
specifies the name of the table to contain the SVD projections of the documents.
For more information about specifying the docPro parameter, see the common casouttable parameter (Appendix A: Common Parameters).
docStdMultiple=double
Specifies how many standard deviations above the mean to set the document cutoff. This parameter requires a SAS Visual Text Analytics license.
| Default | 1 |
| Range | 0–10 |
exactDocPro=True | False
Specifies if the exact document projection values should be output. This parameter requires a SAS Visual Text Analytics license.
| Default | True |
exactWeight=True | False
| Alias | exactWeights |
| Default | False |
k=integer
specifies the number of dimensions to be extracted (also the number of derived topics). If the input data is too small for the requested number of dimensions, this value is adjusted to complete the calculation.
| Alias | numTopics |
| Range | 1–1000 |
legacyNames=True | False
specifies whether to use the legacy variable names on tables. This parameter requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
| Default | False |
maxK=integer
specifies the maximum number of dimensions to be extracted. The maxK option can be used in conjunction with the resolution option to dynamically select the recommended number of dimensions. If you wish to use a specific number of dimensions use maxK and set the resolution to high, or use the k parameter.
| Default | 10 |
| Range | 1–1000 |
nThreads=integer
specifies number of threads to be used per node. If not set, or if a value of 0 is specified, all available threads will be used.
| Default | 8 |
| Range | 0–64 |
norm="ALL" | "DOC" | "NONE" | "WORD"
indicates whether the document projections, term projections, or both are normalized. The normalization converts the representation from depending on angles between vectors to one based on Euclidean distances between vectors.
| Default | ALL |
numLabels=integer
specifies the number of terms to use in the descriptive label for each topic.
| Default | 5 |
| Range | 1–500 |
* parent={castable}
specifies the input CAS table that contains the term-by-document matrix in transaction form. The table must have at last three variables, one containing the document id, a second containing the term id, and the third containing the value in the cell corresponding to that particular term and document.
| Long form | parent={"name":"table-name"} |
| Shortcut form | parent="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 |
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the variables to use for grouping results.
"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.
"groupByMode":"NOSORT" | "REDISTRIBUTE"
"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 |
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"where":"where-expression"
specifies an expression for subsetting the input data.
resolution="HIGH" | "LOW" | "MED"
specifies the desired resolution level for the recommended number of dimensions to be extracted by the SVD.
| Default | HIGH |
rotate="PROMAX" | "VARIMAX"
specifies the type of rotation used to maximize the explanatory power of each topic. A VARIMAX rotation produces uncorrelated topics and a PROMAX rotation produces correlated topics.
| Default | VARIMAX |
rowPivot=double
Specifies the row pivot weight for document normalization of the parent table before the SVD. A negative value turns off the rowPivot process. When topics are requested a rowPivot=1 value is used by default. This parameter requires a SAS Visual Text Analytics license.
| Default | -1 |
| Range | -1–1 |
s={casouttable}
specifies the S matrix, which is a diagonal matrix that is output in compressed form, with two variables and k rows. The variable _ID_ indicates the row and column of the entry and the variable S contains the singular values.
For more information about specifying the s parameter, see the common casouttable parameter (Appendix A: Common Parameters).
scoreConfig={casouttable}
Specifies the output scoring config file.
For more information about specifying the scoreConfig parameter, see the common casouttable parameter (Appendix A: Common Parameters).
termId="variable-name"
specifies the variable that contains the term ID. The contents of this variable must be an integer greater than or equal to 1. There can be no missing values in this variable.
| Default | "_TERMNUM_" |
termStdMultiple=double
Specifies how many standard deviations above the mean to set the term cutoff. This parameter requires a SAS Visual Text Analytics license.
| Default | 1 |
| Range | 0–10 |
termTopics={casouttable}
specifies the name of the output CAS table to contain the term-by-topic sparse matrix information.
For more information about specifying the termTopics parameter, see the common casouttable parameter (Appendix A: Common Parameters).
terms={castable}
specifies the name of the input table that contains information about the terms in the document collection. The table is used to determine which terms to use in the topic calculation.
| Long form | terms={"name":"table-name"} |
| Shortcut form | terms="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 |
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the variables to use for grouping results.
"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.
"groupByMode":"NOSORT" | "REDISTRIBUTE"
"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 |
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"where":"where-expression"
specifies an expression for subsetting the input data.
tolerance=double
specifies the stopping threshold for the iterative factorization algorithm. If 0 is specified the default value is used.
| Default | 1e-06 |
| Range | 0–1 |
topicDecision=True | False
Specifies to include topic membership decisions and document cutoffs in the output tables. This parameter requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
| Default | False |
topics={casouttable}
specifies the output CAS table to contain the topics that are discovered.
For more information about specifying the topics parameter, see the common casouttable parameter (Appendix A: Common Parameters).
u={casouttable}
specifies the U matrix, which contains the left singular vectors. The matrix U is number of terms by k+1.
For more information about specifying the u parameter, see the common casouttable parameter (Appendix A: Common Parameters).
v={casouttable}
specifies the transpose of the matrix containing the right singular vectors. The matrix V is number of documents by k+1.
For more information about specifying the v parameter, see the common casouttable parameter (Appendix A: Common Parameters).
wordPro={casouttable}
specifies the table to contain the projections of the terms. If k dimensions of the SVD are found and the input data set contains n terms, this table will have n rows and k+1 columns.
For more information about specifying the wordPro parameter, see the common casouttable parameter (Appendix A: Common Parameters).
tmSvd Action
Computes the SVD factorization and generates topics. This action requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
R Syntax
Parameter Descriptions
config=list(castable)
specifies the name of the input CAS table that contains parsing configuration information
| Alias | parseConfig |
| Long form | config=list(name="table-name") |
| Shortcut form | config="table-name" |
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 |
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the variables to use for grouping results.
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.
groupByMode="NOSORT" | "REDISTRIBUTE"
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 |
orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
count="variable-name"
specifies the variable that contains the, possibly weighted, term count. The values in this variable must be numeric. There can be no missing values in this variable.
| Default | "_COUNT_" |
docId="variable-name"
specifies the variable that contains the document ID. The type of this variable can either be numeric or a string. There can be no missing values in this variable.
| Default | "_DOCUMENT_" |
docPro=list(casouttable)
specifies the name of the table to contain the SVD projections of the documents.
For more information about specifying the docPro parameter, see the common casouttable parameter (Appendix A: Common Parameters).
docStdMultiple=double
Specifies how many standard deviations above the mean to set the document cutoff. This parameter requires a SAS Visual Text Analytics license.
| Default | 1 |
| Range | 0–10 |
exactDocPro=TRUE | FALSE
Specifies if the exact document projection values should be output. This parameter requires a SAS Visual Text Analytics license.
| Default | TRUE |
exactWeight=TRUE | FALSE
| Alias | exactWeights |
| Default | FALSE |
k=integer
specifies the number of dimensions to be extracted (also the number of derived topics). If the input data is too small for the requested number of dimensions, this value is adjusted to complete the calculation.
| Alias | numTopics |
| Range | 1–1000 |
legacyNames=TRUE | FALSE
specifies whether to use the legacy variable names on tables. This parameter requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
| Default | FALSE |
maxK=integer
specifies the maximum number of dimensions to be extracted. The maxK option can be used in conjunction with the resolution option to dynamically select the recommended number of dimensions. If you wish to use a specific number of dimensions use maxK and set the resolution to high, or use the k parameter.
| Default | 10 |
| Range | 1–1000 |
nThreads=integer
specifies number of threads to be used per node. If not set, or if a value of 0 is specified, all available threads will be used.
| Default | 8 |
| Range | 0–64 |
norm="ALL" | "DOC" | "NONE" | "WORD"
indicates whether the document projections, term projections, or both are normalized. The normalization converts the representation from depending on angles between vectors to one based on Euclidean distances between vectors.
| Default | ALL |
numLabels=integer
specifies the number of terms to use in the descriptive label for each topic.
| Default | 5 |
| Range | 1–500 |
* parent=list(castable)
specifies the input CAS table that contains the term-by-document matrix in transaction form. The table must have at last three variables, one containing the document id, a second containing the term id, and the third containing the value in the cell corresponding to that particular term and document.
| Long form | parent=list(name="table-name") |
| Shortcut form | parent="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 |
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the variables to use for grouping results.
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.
groupByMode="NOSORT" | "REDISTRIBUTE"
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 |
orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
resolution="HIGH" | "LOW" | "MED"
specifies the desired resolution level for the recommended number of dimensions to be extracted by the SVD.
| Default | HIGH |
rotate="PROMAX" | "VARIMAX"
specifies the type of rotation used to maximize the explanatory power of each topic. A VARIMAX rotation produces uncorrelated topics and a PROMAX rotation produces correlated topics.
| Default | VARIMAX |
rowPivot=double
Specifies the row pivot weight for document normalization of the parent table before the SVD. A negative value turns off the rowPivot process. When topics are requested a rowPivot=1 value is used by default. This parameter requires a SAS Visual Text Analytics license.
| Default | -1 |
| Range | -1–1 |
s=list(casouttable)
specifies the S matrix, which is a diagonal matrix that is output in compressed form, with two variables and k rows. The variable _ID_ indicates the row and column of the entry and the variable S contains the singular values.
For more information about specifying the s parameter, see the common casouttable parameter (Appendix A: Common Parameters).
scoreConfig=list(casouttable)
Specifies the output scoring config file.
For more information about specifying the scoreConfig parameter, see the common casouttable parameter (Appendix A: Common Parameters).
termId="variable-name"
specifies the variable that contains the term ID. The contents of this variable must be an integer greater than or equal to 1. There can be no missing values in this variable.
| Default | "_TERMNUM_" |
termStdMultiple=double
Specifies how many standard deviations above the mean to set the term cutoff. This parameter requires a SAS Visual Text Analytics license.
| Default | 1 |
| Range | 0–10 |
termTopics=list(casouttable)
specifies the name of the output CAS table to contain the term-by-topic sparse matrix information.
For more information about specifying the termTopics parameter, see the common casouttable parameter (Appendix A: Common Parameters).
terms=list(castable)
specifies the name of the input table that contains information about the terms in the document collection. The table is used to determine which terms to use in the topic calculation.
| Long form | terms=list(name="table-name") |
| Shortcut form | terms="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 |
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the variables to use for grouping results.
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.
groupByMode="NOSORT" | "REDISTRIBUTE"
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 |
orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
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.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
tolerance=double
specifies the stopping threshold for the iterative factorization algorithm. If 0 is specified the default value is used.
| Default | 1e-06 |
| Range | 0–1 |
topicDecision=TRUE | FALSE
Specifies to include topic membership decisions and document cutoffs in the output tables. This parameter requires a SAS Visual Text Analytics license or a SAS Visual Data Mining and Machine Learning license.
| Default | FALSE |
topics=list(casouttable)
specifies the output CAS table to contain the topics that are discovered.
For more information about specifying the topics parameter, see the common casouttable parameter (Appendix A: Common Parameters).
u=list(casouttable)
specifies the U matrix, which contains the left singular vectors. The matrix U is number of terms by k+1.
For more information about specifying the u parameter, see the common casouttable parameter (Appendix A: Common Parameters).
v=list(casouttable)
specifies the transpose of the matrix containing the right singular vectors. The matrix V is number of documents by k+1.
For more information about specifying the v parameter, see the common casouttable parameter (Appendix A: Common Parameters).
wordPro=list(casouttable)
specifies the table to contain the projections of the terms. If k dimensions of the SVD are found and the input data set contains n terms, this table will have n rows and k+1 columns.
For more information about specifying the wordPro parameter, see the common casouttable parameter (Appendix A: Common Parameters).