importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},

name="table-name",

onDemand=TRUE | FALSE,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression"

}

linksVar={

auxWeight="variable-name",

from="variable-name",

id="variable-name",

to="variable-name",

vars={"variable-name-1" <, "variable-name-2", ...>},

weight="variable-name"

}

logFreqTime=integer

logLevel="AGGRESSIVE" | "BASIC" | "MODERATE" | "NONE"

nThreads=integer

nodes={

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},

name="table-name",

onDemand=TRUE | FALSE,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression"

}

nodesVar={

node="variable-name",

vars={"variable-name-1" <, "variable-name-2", ...>},

weight="variable-name"

}

outLinks={

caslib="string",

compress=TRUE | FALSE,

indexVars={"variable-name-1" <, "variable-name-2", ...>},

label="string",

maxMemSize=64-bit-integer,

name="table-name",

onDemand=TRUE | FALSE,

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

timeStamp="string",

where={"string-1" <, "string-2", ...>}

}

outNodes={

caslib="string",

compress=TRUE | FALSE,

indexVars={"variable-name-1" <, "variable-name-2", ...>},

label="string",

maxMemSize=64-bit-integer,

name="table-name",

onDemand=TRUE | FALSE,

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

timeStamp="string",

where={"string-1" <, "string-2", ...>}

}

outputTables={

groupByVarsRaw=TRUE | FALSE,

includeAll=TRUE | FALSE,

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},

repeated=TRUE | FALSE,

replace=TRUE | FALSE

}

pageRank="BOTH" | "UNWEIGHT" | "WEIGHT"

pageRankAlpha=double

pageRankTolerance=double

standardizedLabels=TRUE | FALSE

;

Parameter Descriptions

auth="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of authority centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

between="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of betweenness centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

betweenNorm=TRUE | FALSE

when set to True, normalizes the betweenness centrality calculation.

Default

TRUE

close="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of closeness centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

closeNoPath="DIAMETER" | "HARMONIC" | "NNODES" | "ZERO"

specifies a method of accounting for the shortest path distance between two nodes when a path does not exist (disconnected nodes).

Default

DIAMETER

uses the graph diameter (plus 1) as the shortest path distance between disconnected nodes.

HARMONIC

uses the harmonic formula for calculating closeness centrality.

NNODES

uses the number of nodes as the shortest path distance between disconnected nodes. You cannot specify this value when the value of the close parameter is WEIGHT or BOTH.

ZERO

uses zero as the shortest path distance between disconnected nodes.

clusteringCoef=TRUE | FALSE

when set to True, calculates the node clustering coefficient.

Default

FALSE

degree=TRUE | FALSE

when set to True, calculates the degree centrality.

Default

FALSE

direction="DIRECTED" | "UNDIRECTED"

specifies whether to consider the input graph as directed or undirected.

Default

UNDIRECTED

DIRECTED

specifies the graph as 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.

UNDIRECTED

specifies the input graph as undirected. In an undirected graph, each link {i,j} has no direction, and the flow can be in either direction. That is, {i,j} = {j,i}.

display={displayTables}

specifies a list of results tables to send to the client for display.

For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).

distributed=TRUE | FALSE

when set to True, uses a distributed graph.

Default

FALSE

eigen="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of eigenvector centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

eigenAlgorithm="AUTOMATIC" | "JACOBIDAVIDSON" | "POWER"

specifies the algorithm to use in calculating centrality metrics that require solving eigensystems - that is, when the eigen, hub, or auth parameter (or some combination) is specified.

Default

AUTOMATIC

automatically determines which eigensolver to use.

JACOBIDAVIDSON

uses a variant of the Jacobi-Davidson algorithm for solving eigensystems.

Alias

POWER

uses the power method to calculate eigenvectors.

eigenMaxIters=integer

specifies the maximum number of iterations to use for eigenvector calculations in order to limit the computation time when convergence is slow.

Default	10000
Minimum value	1

hub="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of hub centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

includeSelfLink=TRUE | FALSE

when set to True, includes self-links when an input graph is read.

Default

FALSE

indexOffset=integer

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 1, 2, and 3 by default. If the value of indexOffset is 4, the entities are labeled entity 4, 5, and 6.

Default	0
Minimum value	0

influence="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of influence centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

internalFormat="FULL" | "THIN"

specifies the internal graph format to use for the graph data structure.

Default

FULL

stores the graph in standard (adjacency-list-based) format.

THIN

stores the graph in thin (simple list of links) format. This parameter can improve performance in some cases both by reducing memory and by simplifying the construction of the internal data structures. It causes the action to skip the removal of duplicate links when it reads in the graph.

links={castable}

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:

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.

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

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

linksVar={linksVarT}

specifies the data variable names for the links table.

For more information about specifying the linksVar parameter, see the common linksVarT parameter (Appendix A: Common Parameters).

logFreqTime=integer

controls the frequency, in number of seconds, for displaying iteration logs. This parameter is useful for computationally intensive algorithms. Setting this value too low can hurt algorithm performance. The value of the parameter can be any integer greater than or equal to 1.

Alias	logFrequencyTime
Default	5
Minimum value	1

logLevel="AGGRESSIVE" | "BASIC" | "MODERATE" | "NONE"

controls the amount of information that is displayed in the SAS log.

Default

BASIC

AGGRESSIVE

displays a more detailed summary of the input, output, and algorithmic processing.

BASIC

displays a brief summary of the algorithmic processing.

MODERATE

displays a moderately detailed summary of the input, output, and algorithmic processing.

NONE

turns off all action-related messages in the SAS log.

nThreads=integer

specifies the maximum number of threads to use for multithreaded processing.

Range

1–256

nodes={castable}

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:

caslib="string"

specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	FALSE

computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.

Alias

compVars

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias

compPgm

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Alias

options, dataSource

importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias

import

The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the table to use.

onDemand=TRUE | FALSE

This parameter is deprecated.

Default

TRUE

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

nodesVar={nodesVarT}

specifies the data variable names for the nodes table.

Long form	nodesVar={node="variable-name"}
Shortcut form	nodesVar="variable-name"

The nodesVarT value can be one or more of the following:

node="variable-name"

specifies the data variable name for the nodes.

Default

"node"

vars={"variable-name-1" <, "variable-name-2", ...>}

specifies the additional data variable names for node attributes.

weight="variable-name"

specifies the data variable name for the node weights.

Default

"weight"

outLinks={casouttable}

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 parameter (Appendix A: Common Parameters).

outNodes={casouttable}

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 parameter (Appendix A: Common Parameters).

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).

pageRank="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of PageRank centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

pageRankAlpha=double

specifies the damping factor for the PageRank algorithm.

Default	0.85
Range	0–1

pageRankTolerance=double

specifies the convergence tolerance for the PageRank algorithm.

Default	1e-09
Range	0–1

standardizedLabels=TRUE | FALSE

when set to True, specifies that the input graph data are in a standardized format.

Default

FALSE

Result Descriptions

ProblemSummary

contains a basic summary of the graph input. The result is a table. You can access the value from results.ProblemSummary.

SolutionSummary

contains a basic solution summary for the algorithm. The result is a table. You can access the value from results.SolutionSummary.

solutionStatus

indicates the solution status of the selected problem type (algorithm class). The result is a string. You can access the value from results.solutionStatus.

centrality Action

Calculates the centrality metrics of a graph.

Lua Syntax

results, info = s:network_centrality{

auth="BOTH" | "UNWEIGHT" | "WEIGHT",

between="BOTH" | "UNWEIGHT" | "WEIGHT",

betweenNorm=true | false,

close="BOTH" | "UNWEIGHT" | "WEIGHT",

closeNoPath="DIAMETER" | "HARMONIC" | "NNODES" | "ZERO",

clusteringCoef=true | false,

degree=true | false,

direction="DIRECTED" | "UNDIRECTED",

display={

caseSensitive=true | false,

exclude=true | false,

excludeAll=true | false,

keyIsPath=true | false,

names={"string-1" <, "string-2", ...>},

pathType="LABEL" | "NAME",

traceNames=true | false

distributed=true | false,

eigen="BOTH" | "UNWEIGHT" | "WEIGHT",

eigenAlgorithm="AUTOMATIC" | "JACOBIDAVIDSON" | "POWER",

eigenMaxIters=integer,

hub="BOTH" | "UNWEIGHT" | "WEIGHT",

includeSelfLink=true | false,

indexOffset=integer,

influence="BOTH" | "UNWEIGHT" | "WEIGHT",

internalFormat="FULL" | "THIN",

links={

caslib="string",

computedOnDemand=true | false,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},

name="table-name",

onDemand=true | false,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression"

linksVar={

auxWeight="variable-name",

from="variable-name",

id="variable-name",

to="variable-name",

vars={"variable-name-1" <, "variable-name-2", ...>},

weight="variable-name"

logFreqTime=integer,

logLevel="AGGRESSIVE" | "BASIC" | "MODERATE" | "NONE",

nThreads=integer,

nodes={

caslib="string",

computedOnDemand=true | false,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},

name="table-name",

onDemand=true | false,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression"

nodesVar={

node="variable-name",

vars={"variable-name-1" <, "variable-name-2", ...>},

weight="variable-name"

outLinks={

caslib="string",

compress=true | false,

indexVars={"variable-name-1" <, "variable-name-2", ...>},

label="string",

maxMemSize=64-bit-integer,

name="table-name",

onDemand=true | false,

promote=true | false,

replace=true | false,

replication=integer,

timeStamp="string",

where={"string-1" <, "string-2", ...>}

outNodes={

caslib="string",

compress=true | false,

indexVars={"variable-name-1" <, "variable-name-2", ...>},

label="string",

maxMemSize=64-bit-integer,

name="table-name",

onDemand=true | false,

promote=true | false,

replace=true | false,

replication=integer,

timeStamp="string",

where={"string-1" <, "string-2", ...>}

outputTables={

groupByVarsRaw=true | false,

includeAll=true | false,

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},

repeated=true | false,

replace=true | false

pageRank="BOTH" | "UNWEIGHT" | "WEIGHT",

pageRankAlpha=double,

pageRankTolerance=double,

standardizedLabels=true | false

}

Parameter Descriptions

auth="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of authority centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

between="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of betweenness centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

betweenNorm=true | false

when set to True, normalizes the betweenness centrality calculation.

Default

true

close="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of closeness centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

closeNoPath="DIAMETER" | "HARMONIC" | "NNODES" | "ZERO"

specifies a method of accounting for the shortest path distance between two nodes when a path does not exist (disconnected nodes).

Default

DIAMETER

uses the graph diameter (plus 1) as the shortest path distance between disconnected nodes.

HARMONIC

uses the harmonic formula for calculating closeness centrality.

NNODES

uses the number of nodes as the shortest path distance between disconnected nodes. You cannot specify this value when the value of the close parameter is WEIGHT or BOTH.

ZERO

uses zero as the shortest path distance between disconnected nodes.

clusteringCoef=true | false

when set to True, calculates the node clustering coefficient.

Default

false

degree=true | false

when set to True, calculates the degree centrality.

Default

false

direction="DIRECTED" | "UNDIRECTED"

specifies whether to consider the input graph as directed or undirected.

Default

UNDIRECTED

DIRECTED

UNDIRECTED

specifies the input graph as undirected. In an undirected graph, each link {i,j} has no direction, and the flow can be in either direction. That is, {i,j} = {j,i}.

display={displayTables}

specifies a list of results tables to send to the client for display.

For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).

distributed=true | false

when set to True, uses a distributed graph.

Default

false

eigen="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of eigenvector centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

eigenAlgorithm="AUTOMATIC" | "JACOBIDAVIDSON" | "POWER"

specifies the algorithm to use in calculating centrality metrics that require solving eigensystems - that is, when the eigen, hub, or auth parameter (or some combination) is specified.

Default

AUTOMATIC

automatically determines which eigensolver to use.

JACOBIDAVIDSON

uses a variant of the Jacobi-Davidson algorithm for solving eigensystems.

Alias

POWER

uses the power method to calculate eigenvectors.

eigenMaxIters=integer

specifies the maximum number of iterations to use for eigenvector calculations in order to limit the computation time when convergence is slow.

Default	10000
Minimum value	1

hub="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of hub centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

includeSelfLink=true | false

when set to True, includes self-links when an input graph is read.

Default

false

indexOffset=integer

Default	0
Minimum value	0

influence="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of influence centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

internalFormat="FULL" | "THIN"

specifies the internal graph format to use for the graph data structure.

Default

FULL

stores the graph in standard (adjacency-list-based) format.

THIN

links={castable}

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:

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.

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

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

linksVar={linksVarT}

specifies the data variable names for the links table.

For more information about specifying the linksVar parameter, see the common linksVarT parameter (Appendix A: Common Parameters).

logFreqTime=integer

Alias	logFrequencyTime
Default	5
Minimum value	1

logLevel="AGGRESSIVE" | "BASIC" | "MODERATE" | "NONE"

controls the amount of information that is displayed in the SAS log.

Default

BASIC

AGGRESSIVE

displays a more detailed summary of the input, output, and algorithmic processing.

BASIC

displays a brief summary of the algorithmic processing.

MODERATE

displays a moderately detailed summary of the input, output, and algorithmic processing.

NONE

turns off all action-related messages in the SAS log.

nThreads=integer

specifies the maximum number of threads to use for multithreaded processing.

Range

1–256

nodes={castable}

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:

caslib="string"

specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=true | false

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	false

computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.

Alias

compVars

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias

compPgm

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}

specifies data source options.

Alias

options, dataSource

importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias

import

The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the table to use.

onDemand=true | false

This parameter is deprecated.

Default

true

vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies the variables to use in the action.

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

nodesVar={nodesVarT}

specifies the data variable names for the nodes table.

Long form	nodesVar={node="variable-name"}
Shortcut form	nodesVar="variable-name"

The nodesVarT value can be one or more of the following:

node="variable-name"

specifies the data variable name for the nodes.

Default

"node"

vars={"variable-name-1" <, "variable-name-2", ...>}

specifies the additional data variable names for node attributes.

weight="variable-name"

specifies the data variable name for the node weights.

Default

"weight"

outLinks={casouttable}

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 parameter (Appendix A: Common Parameters).

outNodes={casouttable}

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 parameter (Appendix A: Common Parameters).

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).

pageRank="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of PageRank centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

pageRankAlpha=double

specifies the damping factor for the PageRank algorithm.

Default	0.85
Range	0–1

pageRankTolerance=double

specifies the convergence tolerance for the PageRank algorithm.

Default	1e-09
Range	0–1

standardizedLabels=true | false

when set to True, specifies that the input graph data are in a standardized format.

Default

false

Result Descriptions

ProblemSummary

contains a basic summary of the graph input. The result is a table. You can access the value from results.ProblemSummary.

SolutionSummary

contains a basic solution summary for the algorithm. The result is a table. You can access the value from results.SolutionSummary.

solutionStatus

indicates the solution status of the selected problem type (algorithm class). The result is a string. You can access the value from results.solutionStatus.

centrality Action

Calculates the centrality metrics of a graph.

Python Syntax

results= s.network.centrality(

auth="BOTH" | "UNWEIGHT" | "WEIGHT",

between="BOTH" | "UNWEIGHT" | "WEIGHT",

betweenNorm=True | False,

close="BOTH" | "UNWEIGHT" | "WEIGHT",

closeNoPath="DIAMETER" | "HARMONIC" | "NNODES" | "ZERO",

clusteringCoef=True | False,

degree=True | False,

direction="DIRECTED" | "UNDIRECTED",

display={

"caseSensitive":True | False,

"exclude":True | False,

"excludeAll":True | False,

"keyIsPath":True | False,

"names":["string-1" <, "string-2", ...>],

"pathType":"LABEL" | "NAME",

"traceNames":True | False

distributed=True | False,

eigen="BOTH" | "UNWEIGHT" | "WEIGHT",

eigenAlgorithm="AUTOMATIC" | "JACOBIDAVIDSON" | "POWER",

eigenMaxIters=integer,

hub="BOTH" | "UNWEIGHT" | "WEIGHT",

includeSelfLink=True | False,

indexOffset=integer,

influence="BOTH" | "UNWEIGHT" | "WEIGHT",

internalFormat="FULL" | "THIN",

links={

"caslib":"string",

"computedOnDemand":True | False,

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"computedVarsProgram":"string",

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},

"groupBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"importOptions":{"fileType":"AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},

"name":"table-name",

"onDemand":True | False,

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression"

linksVar={

"auxWeight":"variable-name",

"from_":"variable-name",

"id":"variable-name",

"to":"variable-name",

"vars":["variable-name-1" <, "variable-name-2", ...>],

"weight":"variable-name"

logFreqTime=integer,

logLevel="AGGRESSIVE" | "BASIC" | "MODERATE" | "NONE",

nThreads=integer,

nodes={

"caslib":"string",

"computedOnDemand":True | False,

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"computedVarsProgram":"string",

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},

"importOptions":{"fileType":"AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters},

"name":"table-name",

"onDemand":True | False,

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression"

nodesVar={

"node":"variable-name",

"vars":["variable-name-1" <, "variable-name-2", ...>],

"weight":"variable-name"

outLinks={

"caslib":"string",

"compress":True | False,

"indexVars":["variable-name-1" <, "variable-name-2", ...>],

"label":"string",

"maxMemSize":64-bit-integer,

"name":"table-name",

"onDemand":True | False,

"promote":True | False,

"replace":True | False,

"replication":integer,

"timeStamp":"string",

"where":["string-1" <, "string-2", ...>]

outNodes={

"caslib":"string",

"compress":True | False,

"indexVars":["variable-name-1" <, "variable-name-2", ...>],

"label":"string",

"maxMemSize":64-bit-integer,

"name":"table-name",

"onDemand":True | False,

"promote":True | False,

"replace":True | False,

"replication":integer,

"timeStamp":"string",

"where":["string-1" <, "string-2", ...>]

outputTables={

"groupByVarsRaw":True | False,

"includeAll":True | False,

"names":["string-1" <, "string-2", ...>] | {"key-1":{casouttable-1} <, "key-2":{casouttable-2}, ...>},

"repeated":True | False,

"replace":True | False

pageRank="BOTH" | "UNWEIGHT" | "WEIGHT",

pageRankAlpha=double,

pageRankTolerance=double,

standardizedLabels=True | False

)

Parameter Descriptions

auth="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of authority centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

between="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of betweenness centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

betweenNorm=True | False

when set to True, normalizes the betweenness centrality calculation.

Default

True

close="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of closeness centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

closeNoPath="DIAMETER" | "HARMONIC" | "NNODES" | "ZERO"

specifies a method of accounting for the shortest path distance between two nodes when a path does not exist (disconnected nodes).

Default

DIAMETER

uses the graph diameter (plus 1) as the shortest path distance between disconnected nodes.

HARMONIC

uses the harmonic formula for calculating closeness centrality.

NNODES

uses the number of nodes as the shortest path distance between disconnected nodes. You cannot specify this value when the value of the close parameter is WEIGHT or BOTH.

ZERO

uses zero as the shortest path distance between disconnected nodes.

clusteringCoef=True | False

when set to True, calculates the node clustering coefficient.

Default

False

degree=True | False

when set to True, calculates the degree centrality.

Default

False

direction="DIRECTED" | "UNDIRECTED"

specifies whether to consider the input graph as directed or undirected.

Default

UNDIRECTED

DIRECTED

UNDIRECTED

specifies the input graph as undirected. In an undirected graph, each link {i,j} has no direction, and the flow can be in either direction. That is, {i,j} = {j,i}.

display={displayTables}

specifies a list of results tables to send to the client for display.

For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).

distributed=True | False

when set to True, uses a distributed graph.

Default

False

eigen="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of eigenvector centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

eigenAlgorithm="AUTOMATIC" | "JACOBIDAVIDSON" | "POWER"

specifies the algorithm to use in calculating centrality metrics that require solving eigensystems - that is, when the eigen, hub, or auth parameter (or some combination) is specified.

Default

AUTOMATIC

automatically determines which eigensolver to use.

JACOBIDAVIDSON

uses a variant of the Jacobi-Davidson algorithm for solving eigensystems.

Alias

POWER

uses the power method to calculate eigenvectors.

eigenMaxIters=integer

specifies the maximum number of iterations to use for eigenvector calculations in order to limit the computation time when convergence is slow.

Default	10000
Minimum value	1

hub="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of hub centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

includeSelfLink=True | False

when set to True, includes self-links when an input graph is read.

Default

False

indexOffset=integer

Default	0
Minimum value	0

influence="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of influence centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

internalFormat="FULL" | "THIN"

specifies the internal graph format to use for the graph data structure.

Default

FULL

stores the graph in standard (adjacency-list-based) format.

THIN

links={castable}

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:

"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.

"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

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variables to use in the action.

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of format field plus the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the input data.

linksVar={linksVarT}

specifies the data variable names for the links table.

For more information about specifying the linksVar parameter, see the common linksVarT parameter (Appendix A: Common Parameters).

logFreqTime=integer

Alias	logFrequencyTime
Default	5
Minimum value	1

logLevel="AGGRESSIVE" | "BASIC" | "MODERATE" | "NONE"

controls the amount of information that is displayed in the SAS log.

Default

BASIC

AGGRESSIVE

displays a more detailed summary of the input, output, and algorithmic processing.

BASIC

displays a brief summary of the algorithmic processing.

MODERATE

displays a moderately detailed summary of the input, output, and algorithmic processing.

NONE

turns off all action-related messages in the SAS log.

nThreads=integer

specifies the maximum number of threads to use for multithreaded processing.

Range

1–256

nodes={castable}

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:

"caslib":"string"

specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

"computedOnDemand":True | False

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	False

"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.

Alias

compVars

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of format field plus the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"computedVarsProgram":"string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias

compPgm

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}

specifies data source options.

Alias

options, dataSource

"importOptions":{fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias

import_

The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).

* "name":"table-name"

specifies the name of the table to use.

"onDemand":True | False

This parameter is deprecated.

Default

True

"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the variables to use in the action.

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of format field plus the format precision.

"label":"string"

specifies the descriptive label for the variable.

* "name":"variable-name"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"where":"where-expression"

specifies an expression for subsetting the input data.

nodesVar={nodesVarT}

specifies the data variable names for the nodes table.

Long form	nodesVar={"node":"variable-name"}
Shortcut form	nodesVar="variable-name"

The nodesVarT value can be one or more of the following:

"node":"variable-name"

specifies the data variable name for the nodes.

Default

"node"

"vars":["variable-name-1" <, "variable-name-2", ...>]

specifies the additional data variable names for node attributes.

"weight":"variable-name"

specifies the data variable name for the node weights.

Default

"weight"

outLinks={casouttable}

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 parameter (Appendix A: Common Parameters).

outNodes={casouttable}

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 parameter (Appendix A: Common Parameters).

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).

pageRank="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of PageRank centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

pageRankAlpha=double

specifies the damping factor for the PageRank algorithm.

Default	0.85
Range	0–1

pageRankTolerance=double

specifies the convergence tolerance for the PageRank algorithm.

Default	1e-09
Range	0–1

standardizedLabels=True | False

when set to True, specifies that the input graph data are in a standardized format.

Default

False

Result Descriptions

ProblemSummary

contains a basic summary of the graph input. The result is a table. You can access the value from results.ProblemSummary.

SolutionSummary

contains a basic solution summary for the algorithm. The result is a table. You can access the value from results.SolutionSummary.

solutionStatus

indicates the solution status of the selected problem type (algorithm class). The result is a string. You can access the value from results.solutionStatus.

centrality Action

Calculates the centrality metrics of a graph.

R Syntax

results <– cas.network.centrality(s,

auth="BOTH" | "UNWEIGHT" | "WEIGHT",

between="BOTH" | "UNWEIGHT" | "WEIGHT",

betweenNorm=TRUE | FALSE,

close="BOTH" | "UNWEIGHT" | "WEIGHT",

closeNoPath="DIAMETER" | "HARMONIC" | "NNODES" | "ZERO",

clusteringCoef=TRUE | FALSE,

degree=TRUE | FALSE,

direction="DIRECTED" | "UNDIRECTED",

display=list(

caseSensitive=TRUE | FALSE,

exclude=TRUE | FALSE,

excludeAll=TRUE | FALSE,

keyIsPath=TRUE | FALSE,

names=list("string-1" <, "string-2", ...>),

pathType="LABEL" | "NAME",

traceNames=TRUE | FALSE

distributed=TRUE | FALSE,

eigen="BOTH" | "UNWEIGHT" | "WEIGHT",

eigenAlgorithm="AUTOMATIC" | "JACOBIDAVIDSON" | "POWER",

eigenMaxIters=integer,

hub="BOTH" | "UNWEIGHT" | "WEIGHT",

includeSelfLink=TRUE | FALSE,

indexOffset=integer,

influence="BOTH" | "UNWEIGHT" | "WEIGHT",

internalFormat="FULL" | "THIN",

links=list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

computedVarsProgram="string",

dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),

groupBy=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

name="table-name",

onDemand=TRUE | FALSE,

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

where="where-expression"

linksVar=list(

auxWeight="variable-name",

from="variable-name",

id="variable-name",

to="variable-name",

vars=list("variable-name-1" <, "variable-name-2", ...>),

weight="variable-name"

logFreqTime=integer,

logLevel="AGGRESSIVE" | "BASIC" | "MODERATE" | "NONE",

nThreads=integer,

nodes=list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

computedVarsProgram="string",

dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),

name="table-name",

onDemand=TRUE | FALSE,

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

where="where-expression"

nodesVar=list(

node="variable-name",

vars=list("variable-name-1" <, "variable-name-2", ...>),

weight="variable-name"

outLinks=list(

caslib="string",

compress=TRUE | FALSE,

indexVars=list("variable-name-1" <, "variable-name-2", ...>),

label="string",

maxMemSize=64-bit-integer,

name="table-name",

onDemand=TRUE | FALSE,

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

timeStamp="string",

where=list("string-1" <, "string-2", ...>)

outNodes=list(

caslib="string",

compress=TRUE | FALSE,

indexVars=list("variable-name-1" <, "variable-name-2", ...>),

label="string",

maxMemSize=64-bit-integer,

name="table-name",

onDemand=TRUE | FALSE,

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

timeStamp="string",

where=list("string-1" <, "string-2", ...>)

outputTables=list(

groupByVarsRaw=TRUE | FALSE,

includeAll=TRUE | FALSE,

names=list("string-1" <, "string-2", ...>) | list(key-1=list(casouttable-1) <, key-2=list(casouttable-2), ...>),

repeated=TRUE | FALSE,

replace=TRUE | FALSE

pageRank="BOTH" | "UNWEIGHT" | "WEIGHT",

pageRankAlpha=double,

pageRankTolerance=double,

standardizedLabels=TRUE | FALSE

)

Parameter Descriptions

auth="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of authority centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

between="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of betweenness centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

betweenNorm=TRUE | FALSE

when set to True, normalizes the betweenness centrality calculation.

Default

TRUE

close="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of closeness centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

closeNoPath="DIAMETER" | "HARMONIC" | "NNODES" | "ZERO"

specifies a method of accounting for the shortest path distance between two nodes when a path does not exist (disconnected nodes).

Default

DIAMETER

uses the graph diameter (plus 1) as the shortest path distance between disconnected nodes.

HARMONIC

uses the harmonic formula for calculating closeness centrality.

NNODES

uses the number of nodes as the shortest path distance between disconnected nodes. You cannot specify this value when the value of the close parameter is WEIGHT or BOTH.

ZERO

uses zero as the shortest path distance between disconnected nodes.

clusteringCoef=TRUE | FALSE

when set to True, calculates the node clustering coefficient.

Default

FALSE

degree=TRUE | FALSE

when set to True, calculates the degree centrality.

Default

FALSE

direction="DIRECTED" | "UNDIRECTED"

specifies whether to consider the input graph as directed or undirected.

Default

UNDIRECTED

DIRECTED

UNDIRECTED

specifies the input graph as undirected. In an undirected graph, each link {i,j} has no direction, and the flow can be in either direction. That is, {i,j} = {j,i}.

display=list(displayTables)

specifies a list of results tables to send to the client for display.

For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).

distributed=TRUE | FALSE

when set to True, uses a distributed graph.

Default

FALSE

eigen="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of eigenvector centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

eigenAlgorithm="AUTOMATIC" | "JACOBIDAVIDSON" | "POWER"

specifies the algorithm to use in calculating centrality metrics that require solving eigensystems - that is, when the eigen, hub, or auth parameter (or some combination) is specified.

Default

AUTOMATIC

automatically determines which eigensolver to use.

JACOBIDAVIDSON

uses a variant of the Jacobi-Davidson algorithm for solving eigensystems.

Alias

POWER

uses the power method to calculate eigenvectors.

eigenMaxIters=integer

specifies the maximum number of iterations to use for eigenvector calculations in order to limit the computation time when convergence is slow.

Default	10000
Minimum value	1

hub="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of hub centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

includeSelfLink=TRUE | FALSE

when set to True, includes self-links when an input graph is read.

Default

FALSE

indexOffset=integer

Default	0
Minimum value	0

influence="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of influence centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

internalFormat="FULL" | "THIN"

specifies the internal graph format to use for the graph data structure.

Default

FULL

stores the graph in standard (adjacency-list-based) format.

THIN

links=list(castable)

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:

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.

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

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variables to use in the action.

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

linksVar=list(linksVarT)

specifies the data variable names for the links table.

For more information about specifying the linksVar parameter, see the common linksVarT parameter (Appendix A: Common Parameters).

logFreqTime=integer

Alias	logFrequencyTime
Default	5
Minimum value	1

logLevel="AGGRESSIVE" | "BASIC" | "MODERATE" | "NONE"

controls the amount of information that is displayed in the SAS log.

Default

BASIC

AGGRESSIVE

displays a more detailed summary of the input, output, and algorithmic processing.

BASIC

displays a brief summary of the algorithmic processing.

MODERATE

displays a moderately detailed summary of the input, output, and algorithmic processing.

NONE

turns off all action-related messages in the SAS log.

nThreads=integer

specifies the maximum number of threads to use for multithreaded processing.

Range

1–256

nodes=list(castable)

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:

caslib="string"

specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.

computedOnDemand=TRUE | FALSE

when set to True, creates the computed variables when the table is loaded instead of when the action begins.

Alias	compOnDemand
Default	FALSE

computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.

Alias

compVars

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

computedVarsProgram="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

Alias

compPgm

dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)

specifies data source options.

Alias

options, dataSource

importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters)

specifies the settings for reading a table from a data source.

Alias

import

The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).

* name="table-name"

specifies the name of the table to use.

onDemand=TRUE | FALSE

This parameter is deprecated.

Default

TRUE

vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies the variables to use in the action.

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of format field plus the format precision.

label="string"

specifies the descriptive label for the variable.

* name="variable-name"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

where="where-expression"

specifies an expression for subsetting the input data.

nodesVar=list(nodesVarT)

specifies the data variable names for the nodes table.

Long form	nodesVar=list(node="variable-name")
Shortcut form	nodesVar="variable-name"

The nodesVarT value can be one or more of the following:

node="variable-name"

specifies the data variable name for the nodes.

Default

"node"

vars=list("variable-name-1" <, "variable-name-2", ...>)

specifies the additional data variable names for node attributes.

weight="variable-name"

specifies the data variable name for the node weights.

Default

"weight"

outLinks=list(casouttable)

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 parameter (Appendix A: Common Parameters).

outNodes=list(casouttable)

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 parameter (Appendix A: Common Parameters).

outputTables=list(outputTables)

lists the names of results tables to save as CAS tables on the server.

For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).

pageRank="BOTH" | "UNWEIGHT" | "WEIGHT"

specifies which type of PageRank centrality to calculate.

BOTH

calculates the metric based on both weighted and unweighted graphs.

UNWEIGHT

calculates the metric based on the unweighted graph.

WEIGHT

calculates the metric based on the weighted graph.

pageRankAlpha=double

specifies the damping factor for the PageRank algorithm.

Default	0.85
Range	0–1

pageRankTolerance=double

specifies the convergence tolerance for the PageRank algorithm.

Default	1e-09
Range	0–1

standardizedLabels=TRUE | FALSE

when set to True, specifies that the input graph data are in a standardized format.

Default

FALSE

Result Descriptions

ProblemSummary

contains a basic summary of the graph input. The result is a table. You can access the value from results.ProblemSummary.

SolutionSummary

contains a basic solution summary for the algorithm. The result is a table. You can access the value from results.SolutionSummary.

solutionStatus

indicates the solution status of the selected problem type (algorithm class). The result is a string. You can access the value from results.solutionStatus.

Last updated: June 07, 2018