Provides actions for network analysis
Detects communities of a graph.
If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the input data table that contains the graph link information. |
|
|
— |
specifies the input data table that contains the graph node information. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the output data table to describe the links between each community. |
|
|
— |
specifies the output data table to contain properties about each community. |
|
|
— |
specifies the output data table to contain summary information about in-memory graphs. |
|
|
— |
specifies the output data table to contain community information at different resolution levels. |
|
|
— |
specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links. |
|
|
— |
specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes. |
|
|
— |
specifies the output data table to describe the intensity of each node. At the end of community detection, a node could have links that connect to multiple communities. The intensity of a node is computed as the sum of the link weights that connect to nodes in the specified community divided by the total link weights of the node. This data table is computationally expensive to produce, and it requires a large amount of disk space. Therefore, it is not produced if the value of the algorithm parameter is LABELPROPAGATION together with multiple resolution values in the resolutionList parameter. However, if the value of the algorithm parameter is LOUVAIN, the data table is produced and will contain only results corresponding to the smallest value of the resolutionList parameter. |
|
|
names |
lists the names of results tables to save as CAS tables on the server. |
when set to True, ensures that each invocation (with the same machine configuration and parameter settings) produces the same final result.
| Default | TRUE |
|---|
specifies whether to consider the input graph as directed or undirected.
| Default | UNDIRECTED |
|---|
considers the input graph to be directed. In a directed graph, each link (i,j) has a direction that defines how something (such as information) can flow over that link. In link (i,j), the flow is from node i to node j. Node i is called the source (tail) node, and node j is called the sink (head) node.
specifies a list of results tables to send to the client for display.
For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).
when set to True, uses a distributed graph.
| Default | FALSE |
|---|
specifies the variable that defines groups of nodes to fix together for community detection. Each value of the variable must be a 32-bit integer greater than or equal to 0 or missing.
specifies the in-memory graph to use.
| Default | -1 |
|---|
specifies the index offset for identifiers in the log and results output data tables. For example, if three entities are found, they are labeled entity 0, 1, and 2 by default. If the value of indexOffset is 4, the entities are labeled entity 4, 5, and 6.
| Default | 0 |
|---|---|
| Minimum value | 0 |
specifies the percentage of small-weight links to be removed around each node neighborhood.
| Default | 10 |
|---|---|
| Range | 0–100 |
specifies the input data table that contains the graph link information.
| Long form | links={name="table-name"} |
|---|---|
| Shortcut form | links="table-name" |
The castable value can be one or more of the following:
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the names of the variables to use for grouping results.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the input table.
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the data variable names for the links table.
For more information about specifying the linksVar parameter, see the common linksVar parameter (Appendix A: Common Parameters).
controls the frequency n (in seconds) for displaying iteration logs for some algorithms, where n can be any integer greater than or equal to 1. This parameter is useful for computationally intensive algorithms. Setting n too low can hurt algorithm performance.
| Alias | logFrequencyTime |
|---|---|
| Default | 5 |
| Minimum value | 1 |
controls the amount of information that is displayed in the SAS log.
| Default | BASIC |
|---|
specifies the maximum number of iterations that the algorithm can run. The default value of this parameter is 20 when the value of the algorithm parameter is LOUVAIN or 100 when the value of the algorithm parameter is LABELPROPAGATION.
| Minimum value | 1 |
|---|
when set to True, includes multilinks when an input graph is read. By default, the value of this parameter is True for algorithms that support multilinks.
specifies the input data table that contains the graph node information.
| Long form | nodes={name="table-name"} |
|---|---|
| Shortcut form | nodes="table-name" |
The castable value can be one or more of the following:
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the input table.
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the data variable names for the nodes table.
| Long form | nodesVar={node="variable-name"} |
|---|---|
| Shortcut form | nodesVar="variable-name" |
The nodesVar value can be one or more of the following:
specifies the data variable name for the nodes.
| Default | "node" |
|---|
specifies the additional data variable names for node attributes.
specifies the output data variable names for node attributes.
specifies the data variable name for the node weights.
| Default | "weight" |
|---|
specifies the maximum number of threads to use for multithreaded processing.
| Range | 1–1024 |
|---|
specifies the output data table to describe the links between each community.
For more information about specifying the outCommLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain properties about each community.
For more information about specifying the outCommunity parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain summary information about in-memory graphs.
For more information about specifying the outGraphList parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain community information at different resolution levels.
For more information about specifying the outLevel parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links.
For more information about specifying the outLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes.
For more information about specifying the outNodes parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to describe the intensity of each node. At the end of community detection, a node could have links that connect to multiple communities. The intensity of a node is computed as the sum of the link weights that connect to nodes in the specified community divided by the total link weights of the node. This data table is computationally expensive to produce, and it requires a large amount of disk space. Therefore, it is not produced if the value of the algorithm parameter is LABELPROPAGATION together with multiple resolution values in the resolutionList parameter. However, if the value of the algorithm parameter is LOUVAIN, the data table is produced and will contain only results corresponding to the smallest value of the resolutionList parameter.
For more information about specifying the outOverlap parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
lists the names of results tables to save as CAS tables on the server.
For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).
| Alias | displayOut |
|---|
breaks down large communities into smaller ones until the specified conditions are satisfied. This parameter starts with the keyword recursive followed by any combination of three subparameters enclosed in parentheses.
The recursive value can be one or more of the following:
specifies the maximum number of nodes to be contained in any community. The default is the largest number that can be represented by a 32-bit integer.
| Minimum value | 1 |
|---|
specifies the maximum number of links on the shortest path between any pair of nodes in any community. This parameter is ignored when you specify the synchronous label propagation algorithm. The default is the largest number that can be represented by a 32-bit integer.
| Minimum value | 1 |
|---|
specifies a list of resolution values (nonnegative numbers) that are separated by spaces (for example, 4.3 2.1 1.0 0.6 0.2).
when set to True, includes self-links when an input graph is read.
| Default | TRUE |
|---|
when set to True, specifies that the input graph data are in a standardized format.
| Default | FALSE |
|---|
when set to True, requests that the output graph data include standardized format.
| Default | FALSE |
|---|
specifies the tolerance value for when to stop iterations. The Louvain algorithm stops iterations when the percentage modularity gain between two consecutive iterations is less than this value. The label propagation algorithm stops iterations when the percentage of label changes for all nodes in the graph is less than this value. The valid range is strictly between 0 and 1. By default, the tolerance is 0.001 for the Louvain algorithm and the asynchronous label propagation algorithm, or 0.05 for the synchronous label propagation algorithm.
| Alias | modularity |
|---|---|
| Range | (0, 1) |
specifies the variable that defines initial community identifiers for warm starting community detection. Each value of the variable must be a 32-bit integer greater than or equal to 0 or missing.
contains a basic summary of the graph input. The result is a table. You can access the value from results.ProblemSummary.
contains a basic solution summary for the algorithm. The result is a table. You can access the value from results.SolutionSummary.
indicates the solution status of the selected problem type (algorithm class). The result is a string. You can access the value from results.solutionStatus.
Detects communities of a graph.
If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the input data table that contains the graph link information. |
|
|
— |
specifies the input data table that contains the graph node information. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the output data table to describe the links between each community. |
|
|
— |
specifies the output data table to contain properties about each community. |
|
|
— |
specifies the output data table to contain summary information about in-memory graphs. |
|
|
— |
specifies the output data table to contain community information at different resolution levels. |
|
|
— |
specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links. |
|
|
— |
specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes. |
|
|
— |
specifies the output data table to describe the intensity of each node. At the end of community detection, a node could have links that connect to multiple communities. The intensity of a node is computed as the sum of the link weights that connect to nodes in the specified community divided by the total link weights of the node. This data table is computationally expensive to produce, and it requires a large amount of disk space. Therefore, it is not produced if the value of the algorithm parameter is LABELPROPAGATION together with multiple resolution values in the resolutionList parameter. However, if the value of the algorithm parameter is LOUVAIN, the data table is produced and will contain only results corresponding to the smallest value of the resolutionList parameter. |
|
|
names |
lists the names of results tables to save as CAS tables on the server. |
when set to True, ensures that each invocation (with the same machine configuration and parameter settings) produces the same final result.
| Default | true |
|---|
specifies whether to consider the input graph as directed or undirected.
| Default | UNDIRECTED |
|---|
considers the input graph to be directed. In a directed graph, each link (i,j) has a direction that defines how something (such as information) can flow over that link. In link (i,j), the flow is from node i to node j. Node i is called the source (tail) node, and node j is called the sink (head) node.
specifies a list of results tables to send to the client for display.
For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).
when set to True, uses a distributed graph.
| Default | false |
|---|
specifies the variable that defines groups of nodes to fix together for community detection. Each value of the variable must be a 32-bit integer greater than or equal to 0 or missing.
specifies the in-memory graph to use.
| Default | -1 |
|---|
specifies the index offset for identifiers in the log and results output data tables. For example, if three entities are found, they are labeled entity 0, 1, and 2 by default. If the value of indexOffset is 4, the entities are labeled entity 4, 5, and 6.
| Default | 0 |
|---|---|
| Minimum value | 0 |
specifies the percentage of small-weight links to be removed around each node neighborhood.
| Default | 10 |
|---|---|
| Range | 0–100 |
specifies the input data table that contains the graph link information.
| Long form | links={name="table-name"} |
|---|---|
| Shortcut form | links="table-name" |
The castable value can be one or more of the following:
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | false |
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the names of the variables to use for grouping results.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the input table.
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the data variable names for the links table.
For more information about specifying the linksVar parameter, see the common linksVar parameter (Appendix A: Common Parameters).
controls the frequency n (in seconds) for displaying iteration logs for some algorithms, where n can be any integer greater than or equal to 1. This parameter is useful for computationally intensive algorithms. Setting n too low can hurt algorithm performance.
| Alias | logFrequencyTime |
|---|---|
| Default | 5 |
| Minimum value | 1 |
controls the amount of information that is displayed in the SAS log.
| Default | BASIC |
|---|
specifies the maximum number of iterations that the algorithm can run. The default value of this parameter is 20 when the value of the algorithm parameter is LOUVAIN or 100 when the value of the algorithm parameter is LABELPROPAGATION.
| Minimum value | 1 |
|---|
when set to True, includes multilinks when an input graph is read. By default, the value of this parameter is True for algorithms that support multilinks.
specifies the input data table that contains the graph node information.
| Long form | nodes={name="table-name"} |
|---|---|
| Shortcut form | nodes="table-name" |
The castable value can be one or more of the following:
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | false |
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the input table.
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the data variable names for the nodes table.
| Long form | nodesVar={node="variable-name"} |
|---|---|
| Shortcut form | nodesVar="variable-name" |
The nodesVar value can be one or more of the following:
specifies the data variable name for the nodes.
| Default | "node" |
|---|
specifies the additional data variable names for node attributes.
specifies the output data variable names for node attributes.
specifies the data variable name for the node weights.
| Default | "weight" |
|---|
specifies the maximum number of threads to use for multithreaded processing.
| Range | 1–1024 |
|---|
specifies the output data table to describe the links between each community.
For more information about specifying the outCommLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain properties about each community.
For more information about specifying the outCommunity parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain summary information about in-memory graphs.
For more information about specifying the outGraphList parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain community information at different resolution levels.
For more information about specifying the outLevel parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links.
For more information about specifying the outLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes.
For more information about specifying the outNodes parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to describe the intensity of each node. At the end of community detection, a node could have links that connect to multiple communities. The intensity of a node is computed as the sum of the link weights that connect to nodes in the specified community divided by the total link weights of the node. This data table is computationally expensive to produce, and it requires a large amount of disk space. Therefore, it is not produced if the value of the algorithm parameter is LABELPROPAGATION together with multiple resolution values in the resolutionList parameter. However, if the value of the algorithm parameter is LOUVAIN, the data table is produced and will contain only results corresponding to the smallest value of the resolutionList parameter.
For more information about specifying the outOverlap parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
lists the names of results tables to save as CAS tables on the server.
For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).
| Alias | displayOut |
|---|
breaks down large communities into smaller ones until the specified conditions are satisfied. This parameter starts with the keyword recursive followed by any combination of three subparameters enclosed in parentheses.
The recursive value can be one or more of the following:
specifies the maximum number of nodes to be contained in any community. The default is the largest number that can be represented by a 32-bit integer.
| Minimum value | 1 |
|---|
specifies the maximum number of links on the shortest path between any pair of nodes in any community. This parameter is ignored when you specify the synchronous label propagation algorithm. The default is the largest number that can be represented by a 32-bit integer.
| Minimum value | 1 |
|---|
specifies a list of resolution values (nonnegative numbers) that are separated by spaces (for example, 4.3 2.1 1.0 0.6 0.2).
when set to True, includes self-links when an input graph is read.
| Default | true |
|---|
when set to True, specifies that the input graph data are in a standardized format.
| Default | false |
|---|
when set to True, requests that the output graph data include standardized format.
| Default | false |
|---|
specifies the tolerance value for when to stop iterations. The Louvain algorithm stops iterations when the percentage modularity gain between two consecutive iterations is less than this value. The label propagation algorithm stops iterations when the percentage of label changes for all nodes in the graph is less than this value. The valid range is strictly between 0 and 1. By default, the tolerance is 0.001 for the Louvain algorithm and the asynchronous label propagation algorithm, or 0.05 for the synchronous label propagation algorithm.
| Alias | modularity |
|---|---|
| Range | (0, 1) |
specifies the variable that defines initial community identifiers for warm starting community detection. Each value of the variable must be a 32-bit integer greater than or equal to 0 or missing.
contains a basic summary of the graph input. The result is a table. You can access the value from results.ProblemSummary.
contains a basic solution summary for the algorithm. The result is a table. You can access the value from results.SolutionSummary.
indicates the solution status of the selected problem type (algorithm class). The result is a string. You can access the value from results.solutionStatus.
Detects communities of a graph.
If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the input data table that contains the graph link information. |
|
|
— |
specifies the input data table that contains the graph node information. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the output data table to describe the links between each community. |
|
|
— |
specifies the output data table to contain properties about each community. |
|
|
— |
specifies the output data table to contain summary information about in-memory graphs. |
|
|
— |
specifies the output data table to contain community information at different resolution levels. |
|
|
— |
specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links. |
|
|
— |
specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes. |
|
|
— |
specifies the output data table to describe the intensity of each node. At the end of community detection, a node could have links that connect to multiple communities. The intensity of a node is computed as the sum of the link weights that connect to nodes in the specified community divided by the total link weights of the node. This data table is computationally expensive to produce, and it requires a large amount of disk space. Therefore, it is not produced if the value of the algorithm parameter is LABELPROPAGATION together with multiple resolution values in the resolutionList parameter. However, if the value of the algorithm parameter is LOUVAIN, the data table is produced and will contain only results corresponding to the smallest value of the resolutionList parameter. |
|
|
names |
lists the names of results tables to save as CAS tables on the server. |
when set to True, ensures that each invocation (with the same machine configuration and parameter settings) produces the same final result.
| Default | True |
|---|
specifies whether to consider the input graph as directed or undirected.
| Default | UNDIRECTED |
|---|
considers the input graph to be directed. In a directed graph, each link (i,j) has a direction that defines how something (such as information) can flow over that link. In link (i,j), the flow is from node i to node j. Node i is called the source (tail) node, and node j is called the sink (head) node.
specifies a list of results tables to send to the client for display.
For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).
when set to True, uses a distributed graph.
| Default | False |
|---|
specifies the variable that defines groups of nodes to fix together for community detection. Each value of the variable must be a 32-bit integer greater than or equal to 0 or missing.
specifies the in-memory graph to use.
| Default | -1 |
|---|
specifies the index offset for identifiers in the log and results output data tables. For example, if three entities are found, they are labeled entity 0, 1, and 2 by default. If the value of indexOffset is 4, the entities are labeled entity 4, 5, and 6.
| Default | 0 |
|---|---|
| Minimum value | 0 |
specifies the percentage of small-weight links to be removed around each node neighborhood.
| Default | 10 |
|---|---|
| Range | 0–100 |
specifies the input data table that contains the graph link information.
| Long form | links={"name":"table-name"} |
|---|---|
| Shortcut form | links="table-name" |
The castable value can be one or more of the following:
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | False |
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the names of the variables to use for grouping results.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies the settings for reading a table from a data source.
| Alias | import_ |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the input table.
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies the settings for reading a table from a data source.
| Alias | import_ |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the data variable names for the links table.
For more information about specifying the linksVar parameter, see the common linksVar parameter (Appendix A: Common Parameters).
controls the frequency n (in seconds) for displaying iteration logs for some algorithms, where n can be any integer greater than or equal to 1. This parameter is useful for computationally intensive algorithms. Setting n too low can hurt algorithm performance.
| Alias | logFrequencyTime |
|---|---|
| Default | 5 |
| Minimum value | 1 |
controls the amount of information that is displayed in the SAS log.
| Default | BASIC |
|---|
specifies the maximum number of iterations that the algorithm can run. The default value of this parameter is 20 when the value of the algorithm parameter is LOUVAIN or 100 when the value of the algorithm parameter is LABELPROPAGATION.
| Minimum value | 1 |
|---|
when set to True, includes multilinks when an input graph is read. By default, the value of this parameter is True for algorithms that support multilinks.
specifies the input data table that contains the graph node information.
| Long form | nodes={"name":"table-name"} |
|---|---|
| Shortcut form | nodes="table-name" |
The castable value can be one or more of the following:
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | False |
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the settings for reading a table from a data source.
| Alias | import_ |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the input table.
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies the settings for reading a table from a data source.
| Alias | import_ |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the data variable names for the nodes table.
| Long form | nodesVar={"node":"variable-name"} |
|---|---|
| Shortcut form | nodesVar="variable-name" |
The nodesVar value can be one or more of the following:
specifies the data variable name for the nodes.
| Default | "node" |
|---|
specifies the additional data variable names for node attributes.
specifies the output data variable names for node attributes.
specifies the data variable name for the node weights.
| Default | "weight" |
|---|
specifies the maximum number of threads to use for multithreaded processing.
| Range | 1–1024 |
|---|
specifies the output data table to describe the links between each community.
For more information about specifying the outCommLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain properties about each community.
For more information about specifying the outCommunity parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain summary information about in-memory graphs.
For more information about specifying the outGraphList parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain community information at different resolution levels.
For more information about specifying the outLevel parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links.
For more information about specifying the outLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes.
For more information about specifying the outNodes parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to describe the intensity of each node. At the end of community detection, a node could have links that connect to multiple communities. The intensity of a node is computed as the sum of the link weights that connect to nodes in the specified community divided by the total link weights of the node. This data table is computationally expensive to produce, and it requires a large amount of disk space. Therefore, it is not produced if the value of the algorithm parameter is LABELPROPAGATION together with multiple resolution values in the resolutionList parameter. However, if the value of the algorithm parameter is LOUVAIN, the data table is produced and will contain only results corresponding to the smallest value of the resolutionList parameter.
For more information about specifying the outOverlap parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
lists the names of results tables to save as CAS tables on the server.
For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).
| Alias | displayOut |
|---|
breaks down large communities into smaller ones until the specified conditions are satisfied. This parameter starts with the keyword recursive followed by any combination of three subparameters enclosed in parentheses.
The recursive value can be one or more of the following:
specifies the maximum number of nodes to be contained in any community. The default is the largest number that can be represented by a 32-bit integer.
| Minimum value | 1 |
|---|
specifies the maximum number of links on the shortest path between any pair of nodes in any community. This parameter is ignored when you specify the synchronous label propagation algorithm. The default is the largest number that can be represented by a 32-bit integer.
| Minimum value | 1 |
|---|
specifies a list of resolution values (nonnegative numbers) that are separated by spaces (for example, 4.3 2.1 1.0 0.6 0.2).
when set to True, includes self-links when an input graph is read.
| Default | True |
|---|
when set to True, specifies that the input graph data are in a standardized format.
| Default | False |
|---|
when set to True, requests that the output graph data include standardized format.
| Default | False |
|---|
specifies the tolerance value for when to stop iterations. The Louvain algorithm stops iterations when the percentage modularity gain between two consecutive iterations is less than this value. The label propagation algorithm stops iterations when the percentage of label changes for all nodes in the graph is less than this value. The valid range is strictly between 0 and 1. By default, the tolerance is 0.001 for the Louvain algorithm and the asynchronous label propagation algorithm, or 0.05 for the synchronous label propagation algorithm.
| Alias | modularity |
|---|---|
| Range | (0, 1) |
specifies the variable that defines initial community identifiers for warm starting community detection. Each value of the variable must be a 32-bit integer greater than or equal to 0 or missing.
contains a basic summary of the graph input. The result is a table. You can access the value from results.ProblemSummary.
contains a basic solution summary for the algorithm. The result is a table. You can access the value from results.SolutionSummary.
indicates the solution status of the selected problem type (algorithm class). The result is a string. You can access the value from results.solutionStatus.
Detects communities of a graph.
If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the input data table that contains the graph link information. |
|
|
— |
specifies the input data table that contains the graph node information. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the output data table to describe the links between each community. |
|
|
— |
specifies the output data table to contain properties about each community. |
|
|
— |
specifies the output data table to contain summary information about in-memory graphs. |
|
|
— |
specifies the output data table to contain community information at different resolution levels. |
|
|
— |
specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links. |
|
|
— |
specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes. |
|
|
— |
specifies the output data table to describe the intensity of each node. At the end of community detection, a node could have links that connect to multiple communities. The intensity of a node is computed as the sum of the link weights that connect to nodes in the specified community divided by the total link weights of the node. This data table is computationally expensive to produce, and it requires a large amount of disk space. Therefore, it is not produced if the value of the algorithm parameter is LABELPROPAGATION together with multiple resolution values in the resolutionList parameter. However, if the value of the algorithm parameter is LOUVAIN, the data table is produced and will contain only results corresponding to the smallest value of the resolutionList parameter. |
|
|
names |
lists the names of results tables to save as CAS tables on the server. |
when set to True, ensures that each invocation (with the same machine configuration and parameter settings) produces the same final result.
| Default | TRUE |
|---|
specifies whether to consider the input graph as directed or undirected.
| Default | UNDIRECTED |
|---|
considers the input graph to be directed. In a directed graph, each link (i,j) has a direction that defines how something (such as information) can flow over that link. In link (i,j), the flow is from node i to node j. Node i is called the source (tail) node, and node j is called the sink (head) node.
specifies a list of results tables to send to the client for display.
For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).
when set to True, uses a distributed graph.
| Default | FALSE |
|---|
specifies the variable that defines groups of nodes to fix together for community detection. Each value of the variable must be a 32-bit integer greater than or equal to 0 or missing.
specifies the in-memory graph to use.
| Default | -1 |
|---|
specifies the index offset for identifiers in the log and results output data tables. For example, if three entities are found, they are labeled entity 0, 1, and 2 by default. If the value of indexOffset is 4, the entities are labeled entity 4, 5, and 6.
| Default | 0 |
|---|---|
| Minimum value | 0 |
specifies the percentage of small-weight links to be removed around each node neighborhood.
| Default | 10 |
|---|---|
| Range | 0–100 |
specifies the input data table that contains the graph link information.
| Long form | links=list(name="table-name") |
|---|---|
| Shortcut form | links="table-name" |
The castable value can be one or more of the following:
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the names of the variables to use for grouping results.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the input table.
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the data variable names for the links table.
For more information about specifying the linksVar parameter, see the common linksVar parameter (Appendix A: Common Parameters).
controls the frequency n (in seconds) for displaying iteration logs for some algorithms, where n can be any integer greater than or equal to 1. This parameter is useful for computationally intensive algorithms. Setting n too low can hurt algorithm performance.
| Alias | logFrequencyTime |
|---|---|
| Default | 5 |
| Minimum value | 1 |
controls the amount of information that is displayed in the SAS log.
| Default | BASIC |
|---|
specifies the maximum number of iterations that the algorithm can run. The default value of this parameter is 20 when the value of the algorithm parameter is LOUVAIN or 100 when the value of the algorithm parameter is LABELPROPAGATION.
| Minimum value | 1 |
|---|
when set to True, includes multilinks when an input graph is read. By default, the value of this parameter is True for algorithms that support multilinks.
specifies the input data table that contains the graph node information.
| Long form | nodes=list(name="table-name") |
|---|---|
| Shortcut form | nodes="table-name" |
The castable value can be one or more of the following:
specifies the caslib for the input table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
|---|---|
| Default | FALSE |
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.
| Alias | compVars |
|---|
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
|---|
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the input table.
specifies the variables to use in the action.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the input data.
specifies an input table that contains rows to use as a WHERE filter. If the vars parameter is not specified, then all the variable names that are common to the input table and the filtering table are used to find matching rows. If the where parameter for the input table and this parameter are specified, then this filtering table is applied first.
The groupbytable value can be one or more of the following:
specifies the caslib for the filter table. By default, the active caslib is used.
specifies the settings for reading a table from a data source.
| Alias | import |
|---|
For more information about specifying the importOptions parameter, see the common importOptions parameter (Appendix A: Common Parameters).
specifies the name of the filter table.
specifies the variable names to use from the filter table.
The casinvardesc value can be one or more of the following:
specifies the format to apply to the variable.
specifies the length of the format field plus the length of the format precision.
specifies the descriptive label for the variable.
specifies the name for the variable.
specifies the length of the format precision.
specifies the length of the format field.
specifies an expression for subsetting the data from the filter table.
specifies the data variable names for the nodes table.
| Long form | nodesVar=list(node="variable-name") |
|---|---|
| Shortcut form | nodesVar="variable-name" |
The nodesVar value can be one or more of the following:
specifies the data variable name for the nodes.
| Default | "node" |
|---|
specifies the additional data variable names for node attributes.
specifies the output data variable names for node attributes.
specifies the data variable name for the node weights.
| Default | "weight" |
|---|
specifies the maximum number of threads to use for multithreaded processing.
| Range | 1–1024 |
|---|
specifies the output data table to describe the links between each community.
For more information about specifying the outCommLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain properties about each community.
For more information about specifying the outCommunity parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain summary information about in-memory graphs.
For more information about specifying the outGraphList parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain community information at different resolution levels.
For more information about specifying the outLevel parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain the graph link information along with any results from the algorithms that calculate metrics on links.
For more information about specifying the outLinks parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to contain the graph node information along with any results from the algorithms that calculate metrics on nodes.
For more information about specifying the outNodes parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
specifies the output data table to describe the intensity of each node. At the end of community detection, a node could have links that connect to multiple communities. The intensity of a node is computed as the sum of the link weights that connect to nodes in the specified community divided by the total link weights of the node. This data table is computationally expensive to produce, and it requires a large amount of disk space. Therefore, it is not produced if the value of the algorithm parameter is LABELPROPAGATION together with multiple resolution values in the resolutionList parameter. However, if the value of the algorithm parameter is LOUVAIN, the data table is produced and will contain only results corresponding to the smallest value of the resolutionList parameter.
For more information about specifying the outOverlap parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).
lists the names of results tables to save as CAS tables on the server.
For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).
| Alias | displayOut |
|---|
breaks down large communities into smaller ones until the specified conditions are satisfied. This parameter starts with the keyword recursive followed by any combination of three subparameters enclosed in parentheses.
The recursive value can be one or more of the following:
specifies the maximum number of nodes to be contained in any community. The default is the largest number that can be represented by a 32-bit integer.
| Minimum value | 1 |
|---|
specifies the maximum number of links on the shortest path between any pair of nodes in any community. This parameter is ignored when you specify the synchronous label propagation algorithm. The default is the largest number that can be represented by a 32-bit integer.
| Minimum value | 1 |
|---|
specifies a list of resolution values (nonnegative numbers) that are separated by spaces (for example, 4.3 2.1 1.0 0.6 0.2).
when set to True, includes self-links when an input graph is read.
| Default | TRUE |
|---|
when set to True, specifies that the input graph data are in a standardized format.
| Default | FALSE |
|---|
when set to True, requests that the output graph data include standardized format.
| Default | FALSE |
|---|
specifies the tolerance value for when to stop iterations. The Louvain algorithm stops iterations when the percentage modularity gain between two consecutive iterations is less than this value. The label propagation algorithm stops iterations when the percentage of label changes for all nodes in the graph is less than this value. The valid range is strictly between 0 and 1. By default, the tolerance is 0.001 for the Louvain algorithm and the asynchronous label propagation algorithm, or 0.05 for the synchronous label propagation algorithm.
| Alias | modularity |
|---|---|
| Range | (0, 1) |
specifies the variable that defines initial community identifiers for warm starting community detection. Each value of the variable must be a 32-bit integer greater than or equal to 0 or missing.
contains a basic summary of the graph input. The result is a table. You can access the value from results.ProblemSummary.
contains a basic solution summary for the algorithm. The result is a table. You can access the value from results.SolutionSummary.
indicates the solution status of the selected problem type (algorithm class). The result is a string. You can access the value from results.solutionStatus.