Hypergroup Action Set: Syntax

hyperGroup.thePlotThickens <result=results> <status=rc> /

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

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

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

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

displayportMaxX=double,

displayportMaxY=double,

displayportMaxZ=double,

displayportMinX=double,

displayportMinY=double,

displayportMinZ=double,

duplicates="DIFFERENTPOINTS" | "ONEPOINT" | "PROHIBIT",

groupByLimit=64-bit-integer,

casLib="string",

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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"

howToMerge="CLOSEST" | "COLOUR" | "RANDOM" | "SMALLEST" | "VOID",

howToMergeList={"CLOSEST", "COLOUR", "RANDOM", "SMALLEST", "VOID"},

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

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

journalTrace=TRUE | FALSE,

maxDepth=64-bit-integer,

maxDepthList={64-bit-integer-1 <, 64-bit-integer-2, ...>},

minCellSize=64-bit-integer,

minCellSizeList={64-bit-integer-1 <, 64-bit-integer-2, ...>},

minSeparation=double,

minSeparationList={double-1 <, double-2, ...>},

nBody=64-bit-integer,

nBodyList={64-bit-integer-1 <, 64-bit-integer-2, ...>},

nCells=64-bit-integer,

nCellsList={64-bit-integer-1 <, 64-bit-integer-2, ...>},

nearestCenter=TRUE | FALSE,

noVars=TRUE | FALSE,

nThreads=integer,

nWorkerThreads=integer,

outputNamedTables=TRUE | FALSE,

readEdges=TRUE | FALSE,

sortImportance=TRUE | FALSE,

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

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"

name="table-name"

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

zeroTol=double

;

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
groupbyTable	—	specifies an input table that contains the groups to use in a group-by analysis.
required parametertable	—	specifies the table containing input data.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—	specifies the settings for an output table.

Parameter Group: N-Body

howToMerge="CLOSEST" | "COLOUR" | "RANDOM" | "SMALLEST" | "VOID"

specifies how cells are merged together.

CLOSEST

merge closest together

COLOUR

merge cells that have the same colour

RANDOM

merge randomly

SMALLEST

merge smallest together

VOID

non-applicable

howToMergeList={"CLOSEST", "COLOUR", "RANDOM", "SMALLEST", "VOID"}

specifies a list indicating how cells are merged together.

CLOSEST

merge closest together

COLOUR

merge cells that have the same colour

RANDOM

merge randomly

SMALLEST

merge smallest together

VOID

non-applicable

maxDepth=64-bit-integer

specifies the maximum depth (and thus how close) vertices in the nBody graph or plot can be.

Default	0
Minimum value	0

maxDepthList={64-bit-integer-1 <, 64-bit-integer-2, ...>}

specifies a list of the maximum depths (and thus how close) vertices in the nBody graphs or plots can be.

minCellSize=64-bit-integer

specifies the minimum number of bodies allowed in any cell.

Default	0
Minimum value	0

minCellSizeList={64-bit-integer-1 <, 64-bit-integer-2, ...>}

specifies a list of the minimum number of bodies allowed in any cell.

minSeparation=double

specifies the minimum distance all cells have to be separated from each other.

Default	0.0
Minimum value	0.0

minSeparationList={double-1 <, double-2, ...>}

specifies a list of the minimum distance all cells have to be separated from each other.

nBody=64-bit-integer

specifies 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

nBodyList={64-bit-integer-1 <, 64-bit-integer-2, ...>}

specifies a list of the approximate number of vertices desired in the nBody graphs. If maxDepthList is specified, the ith nBodyList is the maximum number of vertices (points) desired in the ith graph (plot).

nCells=64-bit-integer

specifies the number of cells- stricter than nBody=.

Default	0
Minimum value	0

nCellsList={64-bit-integer-1 <, 64-bit-integer-2, ...>}

specifies a list of the number of cells- stricter than nBody=.

nearestCenter=TRUE | FALSE

specifies that for all cells, the body nearest to the cells center of mass is to be identified. See the _NearestCenter_ column in the casOut table.

Alias	nearestCentre
Default	FALSE

sortImportance=TRUE | FALSE

specifies to sort the bodies within a bodyCell by their importances

Alias	sortImportances
Default	FALSE

Parameter Group: Output

displayportMaxX=double

specifies the maximum x-axis value (longitude) of the display port.

Aliases	displayportXMax
	XMaxDisplayport
	MaxXDisplayport

displayportMaxY=double

specifies the maximum y-axis value (latitude) of the display port.

Aliases	displayportYMax
	YMaxDisplayport
	MaxYDisplayport

displayportMaxZ=double

specifies the maximum z-axis value of the display port.

Aliases	displayportZMax
	ZMaxDisplayport
	MaxZDisplayport

displayportMinX=double

specifies the minimum x-axis value (longitude) of the display port.

Aliases	displayportXMin
	XMinDisplayport
	MinXDisplayport

displayportMinY=double

specifies the minimum y-axis value (latitude) of the display port.

Aliases	displayportYMin
	YMinDisplayport
	MinYDisplayport

displayportMinZ=double

specifies the minimum z-axis value of the display port.

Aliases	displayportZMin
	ZMinDisplayport
	MinZDisplayport

duplicates="DIFFERENTPOINTS" | "ONEPOINT" | "PROHIBIT"

specifies how duplicate points (points with the same coordinates) are handled.

DIFFERENTPOINTS

specifies duplicates are different points that just happen to have the same coordinates.

ONEPOINT

specifies a duplicate points is only one point present in the data more than once.

PROHIBIT

specifies duplicate points are prohibited.

noVars=TRUE | FALSE

the 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

outputNamedTables=TRUE | FALSE

specifies that output tables will be created if and only if their name is specified.

Default	FALSE

Parameter Group: Performance

journalTrace=TRUE | FALSE

specifies a trace (what the action is doing) is to be journalled, which will appear on console.

Default	FALSE

nThreads=integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Range	0–64

nWorkerThreads=integer

specifies the maximum number of threads any worker is allowed to run.

Range	0–64

zeroTol=double

specifies 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.0

Parameter Group: Reading Data

groupByLimit=64-bit-integer

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

readEdges=TRUE | FALSE

specifies the input table was produced by a previous Hypergroup run as an output Edges table. Reading this is faster.

Default	FALSE

Parameter Descriptions

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

attributes of columns in the inputs list.

For more information about specifying the attributes parameter, see the common casinvardesc parameter.

Aliases	attribute
	attrs
	attr
	varAttrs

casOut={casouttable}

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter.

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

specifies the column that contains colors values

Aliases	colour
	community
	group

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

specifies the list of columns (besides inputs and groupBy columns) to appear in output tables.

Aliases	copyVar
Aliases	extraVars

groupbyTable={groupbytable}

specifies an input table that contains the groups to use in a group-by analysis.

Long form	groupbyTable={name="table-name"}
Shortcut form	groupbyTable="table-name"

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.

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

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

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the filter table.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

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

specifies the column that contains importance values

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

specifies the list of columns to hypergroup, i.e. values will be graph vertices.

For more information about specifying the inputs parameter, see the common casinvardesc parameter.

Alias	input

* table={castable}

specifies the table containing input data.

For more information about specifying the table parameter, see the common castable parameter.

thePlotThickens Action

Determine which points to display in plots with many points.

Lua Syntax

results, info = s:hyperGroup_thePlotThickens{

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

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

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

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

displayportMaxX=double,

displayportMaxY=double,

displayportMaxZ=double,

displayportMinX=double,

displayportMinY=double,

displayportMinZ=double,

duplicates="DIFFERENTPOINTS" | "ONEPOINT" | "PROHIBIT",

groupByLimit=64-bit-integer,

casLib="string",

name="table-name",

where="where-expression"

howToMerge="CLOSEST" | "COLOUR" | "RANDOM" | "SMALLEST" | "VOID",

howToMergeList={"CLOSEST", "COLOUR", "RANDOM", "SMALLEST", "VOID"},

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

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

journalTrace=true | false,

maxDepth=64-bit-integer,

maxDepthList={64-bit-integer-1 <, 64-bit-integer-2, ...>},

minCellSize=64-bit-integer,

minCellSizeList={64-bit-integer-1 <, 64-bit-integer-2, ...>},

minSeparation=double,

minSeparationList={double-1 <, double-2, ...>},

nBody=64-bit-integer,

nBodyList={64-bit-integer-1 <, 64-bit-integer-2, ...>},

nCells=64-bit-integer,

nCellsList={64-bit-integer-1 <, 64-bit-integer-2, ...>},

nearestCenter=true | false,

noVars=true | false,

nThreads=integer,

nWorkerThreads=integer,

outputNamedTables=true | false,

readEdges=true | false,

sortImportance=true | false,

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

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"

name="table-name"

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

zeroTol=double

}

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
groupbyTable	—	specifies an input table that contains the groups to use in a group-by analysis.
required parametertable	—	specifies the table containing input data.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—	specifies the settings for an output table.

Parameter Group: N-Body

howToMerge="CLOSEST" | "COLOUR" | "RANDOM" | "SMALLEST" | "VOID"

specifies how cells are merged together.

CLOSEST

merge closest together

COLOUR

merge cells that have the same colour

RANDOM

merge randomly

SMALLEST

merge smallest together

VOID

non-applicable

howToMergeList={"CLOSEST", "COLOUR", "RANDOM", "SMALLEST", "VOID"}

specifies a list indicating how cells are merged together.

CLOSEST

merge closest together

COLOUR

merge cells that have the same colour

RANDOM

merge randomly

SMALLEST

merge smallest together

VOID

non-applicable

maxDepth=64-bit-integer

specifies the maximum depth (and thus how close) vertices in the nBody graph or plot can be.

Default	0
Minimum value	0

maxDepthList={64-bit-integer-1 <, 64-bit-integer-2, ...>}

specifies a list of the maximum depths (and thus how close) vertices in the nBody graphs or plots can be.

minCellSize=64-bit-integer

specifies the minimum number of bodies allowed in any cell.

Default	0
Minimum value	0

minCellSizeList={64-bit-integer-1 <, 64-bit-integer-2, ...>}

specifies a list of the minimum number of bodies allowed in any cell.

minSeparation=double

specifies the minimum distance all cells have to be separated from each other.

Default	0.0
Minimum value	0.0

minSeparationList={double-1 <, double-2, ...>}

specifies a list of the minimum distance all cells have to be separated from each other.

nBody=64-bit-integer

specifies 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

nBodyList={64-bit-integer-1 <, 64-bit-integer-2, ...>}

nCells=64-bit-integer

specifies the number of cells- stricter than nBody=.

Default	0
Minimum value	0

nCellsList={64-bit-integer-1 <, 64-bit-integer-2, ...>}

specifies a list of the number of cells- stricter than nBody=.

nearestCenter=true | false

specifies that for all cells, the body nearest to the cells center of mass is to be identified. See the _NearestCenter_ column in the casOut table.

Alias	nearestCentre
Default	false

sortImportance=true | false

specifies to sort the bodies within a bodyCell by their importances

Alias	sortImportances
Default	false

Parameter Group: Output

displayportMaxX=double

specifies the maximum x-axis value (longitude) of the display port.

Aliases	displayportXMax
	XMaxDisplayport
	MaxXDisplayport

displayportMaxY=double

specifies the maximum y-axis value (latitude) of the display port.

Aliases	displayportYMax
	YMaxDisplayport
	MaxYDisplayport

displayportMaxZ=double

specifies the maximum z-axis value of the display port.

Aliases	displayportZMax
	ZMaxDisplayport
	MaxZDisplayport

displayportMinX=double

specifies the minimum x-axis value (longitude) of the display port.

Aliases	displayportXMin
	XMinDisplayport
	MinXDisplayport

displayportMinY=double

specifies the minimum y-axis value (latitude) of the display port.

Aliases	displayportYMin
	YMinDisplayport
	MinYDisplayport

displayportMinZ=double

specifies the minimum z-axis value of the display port.

Aliases	displayportZMin
	ZMinDisplayport
	MinZDisplayport

duplicates="DIFFERENTPOINTS" | "ONEPOINT" | "PROHIBIT"

specifies how duplicate points (points with the same coordinates) are handled.

DIFFERENTPOINTS

specifies duplicates are different points that just happen to have the same coordinates.

ONEPOINT

specifies a duplicate points is only one point present in the data more than once.

PROHIBIT

specifies duplicate points are prohibited.

noVars=true | false

the 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

outputNamedTables=true | false

specifies that output tables will be created if and only if their name is specified.

Default	false

Parameter Group: Performance

journalTrace=true | false

specifies a trace (what the action is doing) is to be journalled, which will appear on console.

Default	false

nThreads=integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Range	0–64

nWorkerThreads=integer

specifies the maximum number of threads any worker is allowed to run.

Range	0–64

zeroTol=double

specifies 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.0

Parameter Group: Reading Data

groupByLimit=64-bit-integer

readEdges=true | false

specifies the input table was produced by a previous Hypergroup run as an output Edges table. Reading this is faster.

Default	false

Parameter Descriptions

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

attributes of columns in the inputs list.

For more information about specifying the attributes parameter, see the common casinvardesc parameter.

Aliases	attribute
	attrs
	attr
	varAttrs

casOut={casouttable}

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter.

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

specifies the column that contains colors values

Aliases	colour
	community
	group

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

specifies the list of columns (besides inputs and groupBy columns) to appear in output tables.

Aliases	copyVar
Aliases	extraVars

groupbyTable={groupbytable}

specifies an input table that contains the groups to use in a group-by analysis.

Long form	groupbyTable={name="table-name"}
Shortcut form	groupbyTable="table-name"

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.

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

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

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the filter table.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

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

specifies the column that contains importance values

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

specifies the list of columns to hypergroup, i.e. values will be graph vertices.

For more information about specifying the inputs parameter, see the common casinvardesc parameter.

Alias	input

* table={castable}

specifies the table containing input data.

For more information about specifying the table parameter, see the common castable parameter.

thePlotThickens Action

Determine which points to display in plots with many points.

Python Syntax

results=s.hyperGroup.thePlotThickens(

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

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

color=["variable-name-1" <, "variable-name-2", ...>],

copyVars=["variable-name-1" <, "variable-name-2", ...>],

displayportMaxX=double,

displayportMaxY=double,

displayportMaxZ=double,

displayportMinX=double,

displayportMinY=double,

displayportMinZ=double,

duplicates="DIFFERENTPOINTS" | "ONEPOINT" | "PROHIBIT",

groupByLimit=64-bit-integer,

"casLib":"string",

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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"

howToMerge="CLOSEST" | "COLOUR" | "RANDOM" | "SMALLEST" | "VOID",

howToMergeList=["CLOSEST", "COLOUR", "RANDOM", "SMALLEST", "VOID"],

importance=["variable-name-1" <, "variable-name-2", ...>],

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

journalTrace=True | False,

maxDepth=64-bit-integer,

maxDepthList=[64-bit-integer-1 <, 64-bit-integer-2, ...>],

minCellSize=64-bit-integer,

minCellSizeList=[64-bit-integer-1 <, 64-bit-integer-2, ...>],

minSeparation=double,

minSeparationList=[double-1 <, double-2, ...>],

nBody=64-bit-integer,

nBodyList=[64-bit-integer-1 <, 64-bit-integer-2, ...>],

nCells=64-bit-integer,

nCellsList=[64-bit-integer-1 <, 64-bit-integer-2, ...>],

nearestCenter=True | False,

noVars=True | False,

nThreads=integer,

nWorkerThreads=integer,

outputNamedTables=True | False,

readEdges=True | False,

sortImportance=True | False,

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

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

"name":"table-name"

"vars"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

zeroTol=double

)

indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables
Parameter	Subparameter	Description
groupbyTable	—	specifies an input table that contains the groups to use in a group-by analysis.
required parametertable	—	specifies the table containing input data.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—	specifies the settings for an output table.

Parameter Group: N-Body

"howToMerge":"CLOSEST" | "COLOUR" | "RANDOM" | "SMALLEST" | "VOID"

specifies how cells are merged together.

CLOSEST

merge closest together

COLOUR

merge cells that have the same colour

RANDOM

merge randomly

SMALLEST

merge smallest together

VOID

non-applicable

"howToMergeList":["CLOSEST", "COLOUR", "RANDOM", "SMALLEST", "VOID"]

specifies a list indicating how cells are merged together.

CLOSEST

merge closest together

COLOUR

merge cells that have the same colour

RANDOM

merge randomly

SMALLEST

merge smallest together

VOID

non-applicable

"maxDepth":64-bit-integer

specifies the maximum depth (and thus how close) vertices in the nBody graph or plot can be.

Default	0
Minimum value	0

"maxDepthList":[64-bit-integer-1 <, 64-bit-integer-2, ...>]

specifies a list of the maximum depths (and thus how close) vertices in the nBody graphs or plots can be.

"minCellSize":64-bit-integer

specifies the minimum number of bodies allowed in any cell.

Default	0
Minimum value	0

"minCellSizeList":[64-bit-integer-1 <, 64-bit-integer-2, ...>]

specifies a list of the minimum number of bodies allowed in any cell.

"minSeparation":double

specifies the minimum distance all cells have to be separated from each other.

Default	0.0
Minimum value	0.0

"minSeparationList":[double-1 <, double-2, ...>]

specifies a list of the minimum distance all cells have to be separated from each other.

"nBody":64-bit-integer

specifies 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

"nBodyList":[64-bit-integer-1 <, 64-bit-integer-2, ...>]

"nCells":64-bit-integer

specifies the number of cells- stricter than nBody=.

Default	0
Minimum value	0

"nCellsList":[64-bit-integer-1 <, 64-bit-integer-2, ...>]

specifies a list of the number of cells- stricter than nBody=.

"nearestCenter":True | False

specifies that for all cells, the body nearest to the cells center of mass is to be identified. See the _NearestCenter_ column in the casOut table.

Alias	nearestCentre
Default	False

"sortImportance":True | False

specifies to sort the bodies within a bodyCell by their importances

Alias	sortImportances
Default	False

Parameter Group: Output

"displayportMaxX":double

specifies the maximum x-axis value (longitude) of the display port.

Aliases	displayportXMax
	XMaxDisplayport
	MaxXDisplayport

"displayportMaxY":double

specifies the maximum y-axis value (latitude) of the display port.

Aliases	displayportYMax
	YMaxDisplayport
	MaxYDisplayport

"displayportMaxZ":double

specifies the maximum z-axis value of the display port.

Aliases	displayportZMax
	ZMaxDisplayport
	MaxZDisplayport

"displayportMinX":double

specifies the minimum x-axis value (longitude) of the display port.

Aliases	displayportXMin
	XMinDisplayport
	MinXDisplayport

"displayportMinY":double

specifies the minimum y-axis value (latitude) of the display port.

Aliases	displayportYMin
	YMinDisplayport
	MinYDisplayport

"displayportMinZ":double

specifies the minimum z-axis value of the display port.

Aliases	displayportZMin
	ZMinDisplayport
	MinZDisplayport

"duplicates":"DIFFERENTPOINTS" | "ONEPOINT" | "PROHIBIT"

specifies how duplicate points (points with the same coordinates) are handled.

DIFFERENTPOINTS

specifies duplicates are different points that just happen to have the same coordinates.

ONEPOINT

specifies a duplicate points is only one point present in the data more than once.

PROHIBIT

specifies duplicate points are prohibited.

"noVars":True | False

the 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

"outputNamedTables":True | False

specifies that output tables will be created if and only if their name is specified.

Default	False

Parameter Group: Performance

"journalTrace":True | False

specifies a trace (what the action is doing) is to be journalled, which will appear on console.

Default	False

"nThreads":integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Range	0–64

"nWorkerThreads":integer

specifies the maximum number of threads any worker is allowed to run.

Range	0–64

"zeroTol":double

specifies 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.0

Parameter Group: Reading Data

"groupByLimit":64-bit-integer

"readEdges":True | False

specifies the input table was produced by a previous Hypergroup run as an output Edges table. Reading this is faster.

Default	False

Parameter Descriptions

attributes=[{casinvardesc-1} <, {casinvardesc-2}, ...>]

attributes of columns in the inputs list.

For more information about specifying the attributes parameter, see the common casinvardesc parameter.

Aliases	attribute
	attrs
	attr
	varAttrs

casOut={casouttable}

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter.

color=["variable-name-1" <, "variable-name-2", ...>]

specifies the column that contains colors values

Aliases	colour
	community
	group

copyVars=["variable-name-1" <, "variable-name-2", ...>]

specifies the list of columns (besides inputs and groupBy columns) to appear in output tables.

Aliases	copyVar
Aliases	extraVars

groupbyTable={groupbytable}

specifies an input table that contains the groups to use in a group-by analysis.

Long form	groupbyTable={"name":"table-name"}
Shortcut form	groupbyTable="table-name"

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

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.

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

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

Alias	import_

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* "name":"table-name"

specifies the name of the filter table.

"where":"where-expression"

specifies an expression for subsetting the data from the filter table.

importance=["variable-name-1" <, "variable-name-2", ...>]

specifies the column that contains importance values

inputs=[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies the list of columns to hypergroup, i.e. values will be graph vertices.

For more information about specifying the inputs parameter, see the common casinvardesc parameter.

Alias	input

* table={castable}

specifies the table containing input data.

For more information about specifying the table parameter, see the common castable parameter.

thePlotThickens Action

Determine which points to display in plots with many points.

R Syntax

results <– cas.hyperGroup.thePlotThickens(s,

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

=list(

caslib="string",

compress=TRUE | FALSE,

indexVars=list("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=list("string-1" <, "string-2", ...>)

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

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

displayportMaxX=double,

displayportMaxY=double,

displayportMaxZ=double,

displayportMinX=double,

displayportMinY=double,

displayportMinZ=double,

duplicates="DIFFERENTPOINTS" | "ONEPOINT" | "PROHIBIT",

groupByLimit=64-bit-integer,

=list(

casLib="string",

name="table-name",

where="where-expression"

howToMerge="CLOSEST" | "COLOUR" | "RANDOM" | "SMALLEST" | "VOID",

howToMergeList=list("CLOSEST", "COLOUR", "RANDOM", "SMALLEST", "VOID"),

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

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

journalTrace=TRUE | FALSE,

maxDepth=64-bit-integer,

maxDepthList=list(64-bit-integer-1 <, 64-bit-integer-2, ...>),

minCellSize=64-bit-integer,

minCellSizeList=list(64-bit-integer-1 <, 64-bit-integer-2, ...>),

minSeparation=double,

minSeparationList=list(double-1 <, double-2, ...>),

nBody=64-bit-integer,

nBodyList=list(64-bit-integer-1 <, 64-bit-integer-2, ...>),

nCells=64-bit-integer,

nCellsList=list(64-bit-integer-1 <, 64-bit-integer-2, ...>),

nearestCenter=TRUE | FALSE,

noVars=TRUE | FALSE,

nThreads=integer,

nWorkerThreads=integer,

outputNamedTables=TRUE | FALSE,

readEdges=TRUE | FALSE,

sortImportance=TRUE | FALSE,