hyperGroup

hypergroup

Description

Find hypergroups, graph layouts, colors, communities, centralities, shortests paths, and create structural and nBody graphs.

hyperGroup.hypergroup <result=results> <status=rc> / absFreq=TRUE | FALSE, allGraphs=TRUE | FALSE, allGraphsMax=64-bit-integer, allGraphsMin=64-bit-integer, AllGraphsnBody=64-bit-integer, allGraphsPerGroupBy=TRUE | FALSE, amplifyVertSizes=double, attributes={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, betweenVertexAndVertex2=TRUE | FALSE, c=double, casOut={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, centrality=TRUE | FALSE, closeIters=integer, color=TRUE | FALSE, commAlg="ASYNCHRONOUS" | "LLSEMISYNCHRONOUS" | "LLSYNCHRONOUS" | "SEMISYNCHRONOUS" | "SYNCHRONOUS", commCentrality=TRUE | FALSE, commIters=integer, commlayouts=TRUE | FALSE, commMax=integer, commPrecedence=TRUE | FALSE, community=TRUE | FALSE, copyVars={"variable-name-1" <, "variable-name-2", ...>}, createOut="ALWAYS" | "MULTIPLE" | "NEVER", defaultVertSize=double, degree=TRUE | FALSE, directed=TRUE | FALSE, edges={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, edges2={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, edges3={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, edges4={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, edges5={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, edges6={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, farAway=double, frequency={"variable-name-1" <, "variable-name-2", ...>}, graphPartition=TRUE | FALSE, gridCentralities=TRUE | FALSE, groupByLimit=64-bit-integer, groupbyTable={casLib="string", dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}, importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}, name="table-name", where="where-expression"}, height=double, highDegree=double, implicitFrequencies=TRUE | FALSE, indexC=TRUE | FALSE, inputs={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, journalTrace=TRUE | FALSE, keepAllVertices=TRUE | FALSE, layout="FRUCHGOLD" | "WALSHAW", length=double, longestShortestPath=double, margin=double, maxDepth=64-bit-integer, maxNodes=64-bit-integer, mergeColorSmallest=TRUE | FALSE, mergeCommSmallest=TRUE | FALSE, minColorVertices=64-bit-integer, minCommVertices=64-bit-integer, nameSpace={integer-1 <, integer-2, ...>}, nBody=64-bit-integer, nColors=64-bit-integer, nCommunities=64-bit-integer, nearestCenter=TRUE | FALSE, nIters=integer, noColor=TRUE | FALSE, noColourStrlCoord=TRUE | FALSE, noCommStrlCoord=TRUE | FALSE, noCoord=TRUE | FALSE, nopendants=TRUE | FALSE, noVars=TRUE | FALSE, nShortestPaths=64-bit-integer, nThreads=integer, numericLabels=TRUE | FALSE, nWorkerThreads=integer, outputNamedTables=TRUE | FALSE, parallel=64-bit-integer, particulars=TRUE | FALSE, radians=TRUE | FALSE, reachable=TRUE | FALSE, readEdges=TRUE | FALSE, scaleCentralities="CENTRAL0" | "CENTRAL1" | "NONE", scaleCoords=TRUE | FALSE, separator="EDGES" | "HYBRID" | "VERTICES", shortestPaths={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, shortestPathStart=TRUE | FALSE, sortImportance=TRUE | FALSE, sourcePinned=TRUE | FALSE, standardizedLabels=TRUE | FALSE, startFromCSG=TRUE | FALSE, structural="BOTH" | "COLOUR" | "COMMUNITY" | "NONE", table={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}, {...}}, groupByMode="NOSORT" | "REDISTRIBUTE", importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}, name="table-name", orderBy={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, singlePass=TRUE | FALSE, vars={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, where="where-expression", whereTable={casLib="string", dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}, importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}, name="table-name", vars={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, where="where-expression"}}, threed=TRUE | FALSE, topLeft=TRUE | FALSE, useAllGraphs=TRUE | FALSE, useColors=TRUE | FALSE, useCommunities=TRUE | FALSE, useCoords=TRUE | FALSE, useVertSizes=TRUE | FALSE, vertex="string", vertex2="string", vertex2NameSpace=integer, vertex2Number=64-bit-integer, vertex2Numeric=double, vertexAnalytics=TRUE | FALSE, vertexNameSpace=integer, vertexNumber=64-bit-integer, vertexNumeric=double, verticeNumbersList={64-bit-integer-1 <, 64-bit-integer-2, ...>}, verticeNumericsList={double-1 <, double-2, ...>}, vertices={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, vertices2={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, vertices3={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, vertices4={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, vertices5={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, vertices6={caslib="string", compress=TRUE | FALSE, indexVars={"variable-name-1" <, "variable-name-2", ...>}, label="string", lifetime=64-bit-integer, maxMemSize=64-bit-integer, memoryFormat="DVR" | "INHERIT" | "STANDARD", name="table-name", promote=TRUE | FALSE, replace=TRUE | FALSE, replication=integer, tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE", threadBlockSize=64-bit-integer, timeStamp="string", where={"string-1" <, "string-2", ...>}}, verticesIn={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}, {...}}, groupByMode="NOSORT" | "REDISTRIBUTE", importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}, name="table-name", orderBy={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, singlePass=TRUE | FALSE, vars={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, where="where-expression", whereTable={casLib="string", dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}, importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}, name="table-name", vars={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, where="where-expression"}}, vInAttributes={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, vInInputs={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer}, {...}}, vinOnlyAllCoord={double-1 <, double-2, ...>}, vinOnlyVaryCoord="MISSING" | "X" | "Y" | "Z", weight={"variable-name-1" <, "variable-name-2", ...>}, whichPaths="ALL" | "MINSPANTREE" | "SEQUENTIAL", width=double, xMax=double, xMin=double, yMax=double, yMin=double, zeroTol=double, zMax=double, zMin=double;
Settings
ParameterDescription
absFreqspecifies to use absolute frequencies, useful when frequency data are correlations. Alias: absFrequency. Default: FALSE.
allGraphsspecifies to determine the layout of several or all hypergroup graphs together in one frame. Use allGraphsMin= and allGraphsMax= to control which graphs qualify. Default: FALSE.
allGraphsMaxspecifies the maximum number of vertices a graph can have to qualify for an allGraphs layout. Alias: agMax. Default: INT64_MAX.
allGraphsMinspecifies the minimum number of vertices a graph must have to qualify for an allGraphs layout. Alias: agMin. Default: 1.
AllGraphsnBodyspecifies the approximate number of vertices desired in the nBody AllGraphs. Default: 0. Minimum value: 1.
allGraphsPerGroupByspecifies that allGraph layouts are per GroupBy variable value combination, and not all together regardless of gbvvc. Used when readEdges and useAllGraphs are specified. Alias: agpgb. Default: FALSE.
amplifyVertSizesspecifies that vertex sizes, when greater than average, will be multiplied by this value, and vertex sizes, when less than average, will be divided by this value. Alias: attenuateVertSizes. Default: 1.
attributesattributes of columns in the inputs list. Aliases: attribute, attrs, attr, varAttrs.
betweenVertexAndVertex2specifies that only shortest paths between vertex= and vertex2= (or vertexNumber= and vertex2Number=) are put into the ShortestPaths table. Alias: betweenV. Default: FALSE.
cspecifies the relative strength of local forces to global forces with regard to laying out the positions of vertices and edges. A tuning parameter for layout algorithms. Default: 0.01. Range: 0–1.
casOutspecifies the settings for an output table.
centralityspecifies that centralities are to be determined—a measure of the relative importance of each vertex. Default: FALSE.
closeItersspecifies the number of layout algorithm iterations to execute before it is (re)established which vertices are close together to exert force on each other. Default: 3. Range: 1–2000.
colorspecifies that colors are to be determined. Alias: colour. Default: FALSE.
commAlgspecifies the type of algorithm communities are determined by. Options: ASYNCHRONOUS, LLSEMISYNCHRONOUS, LLSYNCHRONOUS, SEMISYNCHRONOUS, SYNCHRONOUS.
commCentralityspecifies that centralities for each community is needed. Alias: commCent. Default: FALSE.
commItersspecifies the maximum number of iterations the community algorithm can perform. Default: 20. Range: 1–100.
commlayoutsspecifies that layouts for each community is needed. Default: FALSE.
commMaxspecifies the number of community algorithm iterations to perform before the commPrecedence= parameter is used to make labeling decisions.
commPrecedencespecifies the way the community algorithm decides what community a vertex belongs to, when there is a choice. Alias: commPrec. Default: FALSE.
communityspecifies that communities are to be determined. Default: FALSE.
copyVarsspecifies the list of columns (besides inputs and groupBy columns) to appear in output tables. Aliases: copyVar, extraVars.
createOutspecifies whether the casOut table is to be produced. Options: ALWAYS, MULTIPLE, NEVER.
defaultVertSizespecifies the default vertex size. Default: 0.
degreespecified that vertex degrees are to be output. If directed, both in-degree and out-degree are output. Default: FALSE.
directedspecifies that the graph is directed (edges have direction). Default: FALSE.
edgesspecifies the output table containing edge information.
edges2specifies the output table containing edge information for color structural graphs.
edges3specifies the output table containing edge information for community structural graphs.
edges4specifies the output table containing edge information for nBody graphs.
edges5specifies the output table containing edge information for Analytics of Vertices based upon Vertex=.
edges6specifies the output table containing edge information for nBody allGraphs.
farAwayspecifies the extent, for any pair of vertices, that they are considered too far away from each other to exert any force on each other. A layout algorithm tuning parameter. Default: 1. Minimum value: 0.01.
frequencyspecifies the list of columns that have edge frequency (or volume, traffic, or flow) data. Aliases: freq, volume, volumn, traffic, flow.
graphPartitionspecifies that graph partitioning is to be used—the layout algorithms (which depend on layout=, and parallel=) become sub-algorithms. More costly time-wise, but the layout is often better quality. Alias: gp. Default: FALSE.
gridCentralitiesspecifies that centralities will be determined by grid Workers instead of just the grid Controller. Remember to specify or tick the centrality option. Aliases: gridCent, gridCents. Default: FALSE.
groupByLimitspecifies the maximum number of levels in a group-by set. When the server determines this number of levels, the server stops and does not return a result. Specify this parameter if you want to avoid creating large result sets in group-by operations.
groupbyTablespecifies an input table that contains the groups to use in a group-by analysis.
heightspecifies the height of the frame, if threeD is specified. Default: 100. Minimum value: 1.
highDegreespecifies that the layout is initially determined without vertices with high degree, i.e., vertices with degree at least high-degree= times the number of vertices in the graph. Default: 0.75. Range: 0–1.
implicitFrequenciesspecifies that frequencies are implicit, i.e., any edge that is present in the data some number of times will have that frequency value. Aliases: implicitFrequency, implicitFreq. Default: FALSE.
indexCspecified that vertex indices when vertices in each community are together are to be output. Default: FALSE.
inputsspecifies the list of columns to hypergroup, i.e., values will be graph vertices. Alias: input.
journalTracespecifies a trace (what the action is doing) is to be journaled, which will appear on console. Default: FALSE.
keepAllVerticesspecifies that all vertices in the data are to be output even if they have no edges incident onto them. Alias: kav. Default: FALSE.
layoutspecifies the type of layout algorithm. Options: FRUCHGOLD, WALSHAW.
lengthspecifies the length of the frame. Default: 100. Minimum value: 1.
longestShortestPathspecifies that only shortest paths less than or equal to this length are put into the ShortestPaths table. Alias: longestSP. Minimum value: 0.
marginspecifies the margin around the frame left free of vertices coordinates. Default: 10. Minimum value: 0.
maxDepthspecifies the maximum depth (and thus how close) vertices in the nBody graph or plot can be. Default: 0. Minimum value: 0.
maxNodesspecifies that graph partitioning continues as long as any unpartitioned subgraph has at least this number of vertices or, in other words, the maximum number of vertices in subgraphs after graph partitioning is this number. Default: 100. Minimum value: 1.
mergeColorSmallestWhen minColorVertices= specified, merge small colors into small colors. Alias: mergeColourSmallest. Default: FALSE.
mergeCommSmallestWhen minCommVertices= specified, merge small communities into small communities. Default: FALSE.
minColorVerticesColors with this number of vertices, or fewer, are merged into other colors. Alias: minColourVertices. Minimum value: 1.
minCommVerticesCommunities with this number of vertices, or fewer, are merged into other communities. Minimum value: 1.
nameSpacespecifies the list of integers to indicate which inputs variable list columns belong to different name spaces.
nBodyspecifies the approximate number of vertices desired in the nBody graph. If maxDepth is specified, nBody= is the maximum number of vertices desired. Default: 0. Minimum value: 1.
nColorsSmall colors are merged into bigger colors until this number of colors remain. Alias: nColours. Minimum value: 1.
nCommunitiesSmall communities are merged into bigger communities until this number of communities remain. Minimum value: 1.
nearestCenterspecifies that for all cells, the body nearest to the cell's center of mass is to be identified. See the _NearestCenter_ column in the casOut table. Alias: nearestCentre. Default: FALSE.
nItersspecifies the maximum number of iterations the layout algorithms can perform. Alias: niterations. Default: 100. Range: 1–2000.
noColorspecifies that colors are not needed. Alias: noColour. Default: FALSE.
noColourStrlCoordspecifies that coordinates of the color structural graphs are not needed. _XCoord_, _YCoord_, ... etc. in the vertices3= table, and the _SourceX_, _TargetY_, ... etc. in the edges3= table are not needed. Default: FALSE.
noCommStrlCoordspecifies that coordinates of the community structural graphs are not needed. _XCoord_, _YCoord_, ... etc. in the vertices3= table, and the _SourceX_, _TargetY_, ... etc. in the edges3= table are not needed. Default: FALSE.
noCoordspecifies that coordinates of the hypergroup graphs are not needed. Default: FALSE.
noPendantsspecifies during graph partitioning pendant nodes are not to be initially excluded in layouts. Determining layouts without pendants can result in better quality layouts, but it requires an extra layout with them put back in. Default: FALSE.
noVarsthe default copyVars varlist are all columns that are not in the inputs, groupBy, weight, or frequency varlists—noVars indicates you want that default to be no columns. Default: FALSE.
nShortestPathsspecifies the number of shortest paths put into the ShortestPaths table. These are the shortest paths from vertex=, and if vertex2= is specified, from vertex2=. Alias: nSP. Default: 1000. Minimum value: 1.
nThreadsspecifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software. Range: 0–64.
numericLabelsspecifies that the inputs varlist variables have numeric values, can be integer or real numbers. Alias: numLabels. Default: FALSE.
nWorkerThreadsspecifies the maximum number of threads any worker is allowed to run. Range: 0–64.
outputNamedTablesspecifies that output tables will be created if and only if their name is specified. Default: FALSE.
parallelspecifies the way the nBody layout algorithm executes: unthreaded, threaded, threaded and gridded, or not at all. 0: do not use nBody layout. -1: nongridded nonthreaded nBody algorithm used. -2: nongridded nonthreaded synchronized update nBody algorithm used. >=1 nongridded threaded (parallel= threads) nBody algorithm used. Else, gridded threaded nBody algorithm used, with every worker using -parallel-2 threads. Default: 0.
particularsspecifies that for each graph, issue to the journal the number of vertices, edges and, if applicable, properties of the edges. Default: FALSE.
radiansspecifies the angle for centrality are to be in radians rather than degrees. Default: FALSE.
reachablespecifies that the vertices5= and edges5= tables should contain records only for vertices that are reachable from vertex=. Default: FALSE.
readEdgesspecifies the input table was produced by a previous Hypergroup run as an output Edges table. Reading this is faster. Default: FALSE.
scaleCentralitiesspecifies whether stress, closeness, and betweenness centrality are scaled or not and, for these centralities, whether those of the most central vertices have values are at or near 1, or at or near 0. Options: CENTRAL0, CENTRAL1, NONE.
scaleCoordsspecifies the coordinates are to be scaled so they lie within frame as per width= length= and height=, also governed by margin=. Default: FALSE.
separatorspecifies the type of separator graph partitioning uses. Options: EDGES (Alias: ARCS), HYBRID, VERTICES (Alias: NODES).
shortestPathsspecifies the output table containing shortest paths for Analytics of Vertices based upon Vertex= and Vertex2=, if specified.
shortestPathStartspecifies when the graph is directed that vertex=, vertexNumber=, or vertexNumeric= is the start of shortest paths, not their destination. Default: FALSE.
sortImportancespecifies to sort the bodies within a bodyCell by their importances. Aliases: sortImportances. Default: FALSE.
sourcePinnedIf there are weights or frequencies, the i-th weight and frequency is associated with the edge originating at the i-th inputs variable value. If sourcePinned is not specified, the i-th weight and frequency is associated with the edge directed toward the (i+1)-th inputs variable value. Default: FALSE.
standardizedLabelsspecifies that the data has standardized labels format, i.e., inputs varlist variables have integer values 0 1 2..., or 1 2 3.... Alias: stdLabels. Default: FALSE.
startFromCSGStart from Community Structural Graph, adding vertices and edges, to get entire graph layout. Default: FALSE.
structuralspecifies which type of structural graphs are needed. Options: BOTH, COLOUR (Alias: COLOR), COMMUNITY, NONE.
tablespecifies the table containing input data.
threeDspecifies the layout algorithms are to determine coordinates for vertices in 3-dimensions. Default: FALSE.
topLeftspecifies the (0,0) or (0,0,0) point of the frame is at the top left rather than the bottom left. Needed sometimes so 0 degrees is vertically upwards. Default: FALSE.
useAllGraphsWhen reading a table that was previously an Edges= output table, read AllGraphs coordinates rather than redetermine them. Default: FALSE.
useColorsWhen reading a table that was previously an Edges= output table, read colors rather than redetermine them. Alias: useColours. Default: FALSE.
useCommunitiesWhen reading a table that was previously an Edges= output table, read communities rather than redetermine them. Alias: useComms. Default: FALSE.
useCoordsWhen reading a table that was previously an Edges= output table, read coordinates rather than redetermine a layout. Default: FALSE.
useVertSizesWhen reading a table that was previously an Edges= output table, read vertex sizes rather than reading a verticesIn= table. Alias: useVSizes. Default: FALSE.
vertexspecifies the vertex that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables. Alias: vertex1.
vertex2specifies the second vertex that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables.
vertex2NameSpacespecifies the nameSpace of the second vertex that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables. Aliases: v2ns, vns2. Default: -1. Minimum value: 0.
vertex2Numberspecifies the when standardizedLabels is specified, vertex2Number specifies the second vertex that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables. Alias: vertexNumber2. Minimum value: 0.
vertex2Numericwhen numericLabels is specified, vertex2Numeric specifies the second vertex that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables. Alias: vertexNumeric2.
vertexAnalyticsspecifies that Analytics of Vertices are to be performed. Results will be put into the vertices5= and edges5= tables. Default: FALSE.
vertexNameSpacespecifies the nameSpace of the vertex that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables. Aliases: vns, v1ns, vns1. Default: -1. Minimum value: 0.
vertexNumberwhen standardizedLabels is specified, vertexNumber specifies the vertex that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables. Aliases: vertex1Number, vertexNumber1. Minimum value: 0.
vertexNumericwhen numericLabels is specified, vertexNumeric specifies the vertex that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables. Aliases: vertex1Numeric, vertexNumeric1.
verticeNumbersListspecifies the list of vertices (that have standardized labels) that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables.
verticeNumericsListspecifies the list of vertices (that have numeric names) that Analytics of Vertices are to be performed upon. Results will be put into the vertices5= and edges5= tables.
verticesspecifies the output table containing vertices information.
vertices2specifies the output table containing vertices information for color structural graphs.
vertices3specifies the output table containing vertices information for community structural graphs.
vertices4specifies the output table containing vertices information for nBody graphs.
vertices5specifies the output table containing vertices information for Analytics of Vertices based upon Vertex=.
vertices6specifies the output table containing vertices information for nBody allGraphs.
verticesInspecifies the input table containing vertices information.
vInAttributesattributes of columns in the vInInputs list. Aliases: vInAttribute, vInAttrs, vInAttr, vInVarAttrs.
vInInputsspecifies the list of columns in the verticesIn table. Alias: vInInput.
vInOnlyAllCoordused to set or calculate allGraph coordinates for vertices in verticesIn but not in table. Alias: vIOAC.
vInOnlyVaryCoordspecifies that, for vertices in verticesIn but not in table, _AllXCoord_ is different when vInOnlyVaryCoord="X" is specified, _AllYCoord_ is different when vInOnlyVaryCoord="Y" is specified, _AllZCoord_ is different when vInOnlyVaryCoord="Z" is specified, or _AllXCoord_, _AllYCoord_, and _AllZCoord_ are missing values when vInOnlyVaryCoord="MISSING" is specified. Options: MISSING, X, Y, Z.
weightspecifies the list of columns that have edge weight or distance data. Aliases: weights, distance, distances.
whichPathsGiven verticesList, verticeNumbersList, or verticeNumericsList, which shortest paths between these vertices are required? Options: ALL, MINSPANTREE, SEQUENTIAL.
widthspecifies the width of the frame. Default: 100. Minimum value: 1.
xMaxspecifies the maximum x-coordinate vertices have when determining an nBody graph.
xMinspecifies the minimum x-coordinate vertices have when determining an nBody graph.
yMaxspecifies the maximum y-coordinate vertices have when determining an nBody graph.
yMinspecifies the minimum y-coordinate vertices have when determining an nBody graph.
zeroTolspecifies the largest difference between floating point numbers before they are considered to be different, or the amount such a number may differ from zero to be considered nonzero. Aliases: zero, zeroTolerance, fuzz. Default: 1E-06. Minimum value: 0.
zMaxspecifies the maximum z-coordinate vertices have when determining an nBody graph.
zMinspecifies the minimum z-coordinate vertices have when determining an nBody graph.

Examples

FAQ

absFreq
allGraphs
allGraphsMax
allGraphsMin
AllGraphsnBody
allGraphsPerGroupBy
amplifyVertSizes
attributes
betweenVertexAndVertex2
c
casOut
centrality
closeIters
color
commAlg
commCentrality
commIters
commLayouts
commMax
commPrecedence
community
copyVars
createOut
defaultVertSize
degree
directed
edges
edges2
edges3
edges4
edges5
edges6
farAway
frequency
graphPartition
gridCentralities
groupByLimit
groupbyTable
height
highDegree
implicitFrequencies
indexC
inputs
journalTrace
keepAllVertices
layout
length
longestShortestPath
margin
maxDepth
maxNodes
mergeColorSmallest
mergeCommSmallest
minColorVertices
minCommVertices
nameSpace
nBody
nColors
nCommunities
nearestCenter
nIters
noColor
noColourStrlCoord
noCommStrlCoord
noCoord
noPendants
noVars
nShortestPaths
nThreads
numericLabels
nWorkerThreads
outputNamedTables
parallel
particulars
radians
reachable
readEdges
scaleCentralities
scaleCoords
separator
shortestPaths
shortestPathStart
sortImportance
sourcePinned
standardizedLabels
startFromCSG
structural
table
threeD
topLeft
useAllGraphs
useColors
useCommunities
useCoords
useVertSizes
vertex
vertex2
vertex2NameSpace
vertex2Number
vertex2Numeric
vertexAnalytics
vertexNameSpace
vertexNumber
vertexNumeric
verticeNumbersList
verticeNumericsList
vertices
vertices2
vertices3
vertices4
vertices5
vertices6
verticesIn
vInAttributes
vInInputs
vInOnlyAllCoord
vInOnlyVaryCoord
weight
whichPaths
width
xMax
xMin
yMax
yMin
zeroTol
zMax
zMin