Statistical Process Control Action Set

spc.boxChart <result=results> <status=rc> /

allN=TRUE | FALSE,

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

ciAlpha=double,

ciIndices=TRUE | FALSE,

caseSensitive=TRUE | FALSE,

exclude=TRUE | FALSE,

excludeAll=TRUE | FALSE,

keyIsPath=TRUE | FALSE,

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

pathType="LABEL" | "NAME",

traceNames=TRUE | FALSE

exChart=TRUE | FALSE,

groupByLimit=64-bit-integer,

limitN=integer,

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}

name="table-name"

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

no3SigmaCheck=TRUE | FALSE,

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

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

pctlDef=integer,

test1=TRUE | FALSE,

test2=TRUE | FALSE,

test3=TRUE | FALSE,

test4=TRUE | FALSE,

test5=TRUE | FALSE,

test6=TRUE | FALSE,

test7=TRUE | FALSE,

test8=TRUE | FALSE

processName="variable-name",

processValue="variable-name",

sigmas=double,

sMethod="RMSDF" | "RMVLUE" | "RNOWEIGHT" | "SMVLUE" | "SNOWEIGHT",

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"

}

subgroupName="variable-name",

subgroupValue="variable-name",

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"

}

test2Run=integer,

test3Run=integer,

testNStd=TRUE | FALSE,

testOverlap=TRUE | FALSE

;

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
limitsTable	—	specifies the control limits data table.
specsTable	—	specifies the specification limits data table and computes process capability indices.
required parametertable	—	specifies the settings for an input table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
chartsTable	—	specifies the charts summary output data table.
outLimitsTable	—	specifies the output control limits data table.
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

allN=TRUE | FALSE

when set to True, includes all subgroups regardless of whether the subgroup sample size equals the nominal sample size.

Default	FALSE

chartsTable={casouttable}

specifies the charts summary output data table.

For more information about specifying the chartsTable parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

ciAlpha=double

specifies the confidence level that is used to compute capability index confidence limits.

Default	0.05
Minimum value (exclusive)	0

ciIndices=TRUE | FALSE

when set to True, computes capability index confidence limits that are based on subgroup summary data.

Default	FALSE

ciType="LOWER" | "TWOSIDED" | "UPPER"

specifies the type of confidence limits that are computed for capability indices: lower, upper, or two-sided.

Default	TWOSIDED

LOWER

requests lower confidence limits for capability indices.

TWOSIDED

requests two-sided confidence limits for capability indices.

UPPER

requests upper confidence limits for capability indices.

controlStat="MEAN" | "MEDIAN"

specifies whether box chart control limits are computed for subgroup means or subgroup medians.

Default	MEAN

MEAN

computes control limits for subgroup means.

MEDIAN

computes control limits for subgroup medians.

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

exChart=TRUE | FALSE

when set to True, includes a control chart in the results only when exceptions occur.

Default	FALSE

groupByLimit=64-bit-integer

suppresses the analysis if the number of groups exceeds the specified value.

Minimum value	1

limitN=integer

specifies a nominal sample size for the control limits.

limitsTable={castable}

specifies the control limits data table.

For more information about specifying the limitsTable parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

medCentral="AVGMEAN" | "AVGMED" | "MEDMED"

specifies the method of estimating the process mean.

Default	AVGMED

AVGMEAN

uses the average of subgroup means to estimate the process mean.

AVGMED

uses the average of subgroup medians to estimate the process mean.

MEDMED

uses the median of subgroup medians to estimate the process mean.

no3SigmaCheck=TRUE | FALSE

when set to True, enables tests for special causes when the control limits are not three sigma limits.

Default	FALSE

outLimitsTable={casouttable}

specifies the output control limits data table.

For more information about specifying the outLimitsTable parameter, see the common casouttable (Form 1) 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).

Alias	displayOut

pctlDef=integer

specifies the definition that is used to calculate percentiles in constructing box-and-whisker plots.

Default	5

primaryTests={tests}

requests one or more tests for special causes for the primary control chart.

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

test1=TRUE | FALSE

when set to True, requests a test for one point beyond Zone A (outside the control limits).

Default	FALSE

test2=TRUE | FALSE

when set to True, requests a test for nine points in a row on one side of the center line.

Default	FALSE

test3=TRUE | FALSE

when set to True, requests a test for six points in a row steadily increasing or decreasing.

Default	FALSE

test4=TRUE | FALSE

when set to True, requests a test for fourteen points in a row alternating up and down.

Default	FALSE

test5=TRUE | FALSE

when set to True, requests a test for two out of three points in a row in Zone A or beyond.

Default	FALSE

test6=TRUE | FALSE

when set to True, requests a test for four out of five points in a row in Zone B or beyond.

Default	FALSE

test7=TRUE | FALSE

when set to True, requests a test for fifteen points in a row in Zone C (above and below the center line).

Default	FALSE

test8=TRUE | FALSE

when set to True, requests a test for eight points in a row on both sides of the center line with none in Zone C.

Default	FALSE

processName="variable-name"

specifies the variable in the input data table that contains the names of processes to be analyzed.

Default	"processName"

processValue="variable-name"

specifies the variable in the input data table that contains the process measurements to be analyzed.

Default	"process"

sigmas=double

specifies the width of the control limits as a multiple of the standard error of the subgroup summary statistic.

Default	3
Minimum value (exclusive)	0

sMethod="RMSDF" | "RMVLUE" | "RNOWEIGHT" | "SMVLUE" | "SNOWEIGHT"

specifies the method of estimating the process standard deviation.

Default	SNOWEIGHT

RMSDF

requests a weighted root mean square estimate.

RMVLUE

requests a minimum variance linear unbiased estimate that is based on subgroup ranges.

RNOWEIGHT

requests an unweighted estimate that is based on subgroup ranges.

SMVLUE

requests a minimum variance linear unbiased estimate that is based on subgroup standard deviations.

SNOWEIGHT

requests an unweighted estimate that is based on subgroup standard deviations.

specsTable={castable}

specifies the specification limits data table and computes process capability indices.

For more information about specifying the specsTable parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

subgroupName="variable-name"

specifies the variable in the input data table that contains the names of subgroup variables.

Default	"subgroupName"

subgroupValue="variable-name"

specifies the variable in the input data table that contains the subgroup values.

Default	"subgroup"

* table={castable}

specifies the settings for an input table.

For more information about specifying the table parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

test2Run=integer

specifies the length of the pattern for Test 2.

Default	9

test3Run=integer

specifies the length of the pattern for Test 3.

Default	6

testNStd=TRUE | FALSE

when set to True, enables tests for special causes with varying subgroup sample sizes.

Default	FALSE

testOverlap=TRUE | FALSE

when set to True, applies tests for special causes to overlapping patterns of points.

Default	FALSE

boxChart Action

Produces box charts.

Lua Syntax

results, info = s:spc_boxChart{

allN=true | false,

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

ciAlpha=double,

ciIndices=true | false,

caseSensitive=true | false,

exclude=true | false,

excludeAll=true | false,

keyIsPath=true | false,

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

pathType="LABEL" | "NAME",

traceNames=true | false

exChart=true | false,

groupByLimit=64-bit-integer,

limitN=integer,

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"

}

no3SigmaCheck=true | false,

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

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

pctlDef=integer,

test1=true | false,

test2=true | false,

test3=true | false,

test4=true | false,

test5=true | false,

test6=true | false,

test7=true | false,

test8=true | false

processName="variable-name",

processValue="variable-name",

sigmas=double,

sMethod="RMSDF" | "RMVLUE" | "RNOWEIGHT" | "SMVLUE" | "SNOWEIGHT",

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"

}

subgroupName="variable-name",

subgroupValue="variable-name",

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"

}

test2Run=integer,

test3Run=integer,

testNStd=true | false,

testOverlap=true | false

}

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
limitsTable	—	specifies the control limits data table.
specsTable	—	specifies the specification limits data table and computes process capability indices.
required parametertable	—	specifies the settings for an input table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
chartsTable	—	specifies the charts summary output data table.
outLimitsTable	—	specifies the output control limits data table.
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

allN=true | false

when set to True, includes all subgroups regardless of whether the subgroup sample size equals the nominal sample size.

Default	false

chartsTable={casouttable}

specifies the charts summary output data table.

For more information about specifying the chartsTable parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

ciAlpha=double

specifies the confidence level that is used to compute capability index confidence limits.

Default	0.05
Minimum value (exclusive)	0

ciIndices=true | false

when set to True, computes capability index confidence limits that are based on subgroup summary data.

Default	false

ciType="LOWER" | "TWOSIDED" | "UPPER"

specifies the type of confidence limits that are computed for capability indices: lower, upper, or two-sided.

Default	TWOSIDED

LOWER

requests lower confidence limits for capability indices.

TWOSIDED

requests two-sided confidence limits for capability indices.

UPPER

requests upper confidence limits for capability indices.

controlStat="MEAN" | "MEDIAN"

specifies whether box chart control limits are computed for subgroup means or subgroup medians.

Default	MEAN

MEAN

computes control limits for subgroup means.

MEDIAN

computes control limits for subgroup medians.

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

exChart=true | false

when set to True, includes a control chart in the results only when exceptions occur.

Default	false

groupByLimit=64-bit-integer

suppresses the analysis if the number of groups exceeds the specified value.

Minimum value	1

limitN=integer

specifies a nominal sample size for the control limits.

limitsTable={castable}

specifies the control limits data table.

For more information about specifying the limitsTable parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

medCentral="AVGMEAN" | "AVGMED" | "MEDMED"

specifies the method of estimating the process mean.

Default	AVGMED

AVGMEAN

uses the average of subgroup means to estimate the process mean.

AVGMED

uses the average of subgroup medians to estimate the process mean.

MEDMED

uses the median of subgroup medians to estimate the process mean.

no3SigmaCheck=true | false

when set to True, enables tests for special causes when the control limits are not three sigma limits.

Default	false

outLimitsTable={casouttable}

specifies the output control limits data table.

For more information about specifying the outLimitsTable parameter, see the common casouttable (Form 1) 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).

Alias	displayOut

pctlDef=integer

specifies the definition that is used to calculate percentiles in constructing box-and-whisker plots.

Default	5

primaryTests={tests}

requests one or more tests for special causes for the primary control chart.

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

test1=true | false

when set to True, requests a test for one point beyond Zone A (outside the control limits).

Default	false

test2=true | false

when set to True, requests a test for nine points in a row on one side of the center line.

Default	false

test3=true | false

when set to True, requests a test for six points in a row steadily increasing or decreasing.

Default	false

test4=true | false

when set to True, requests a test for fourteen points in a row alternating up and down.

Default	false

test5=true | false

when set to True, requests a test for two out of three points in a row in Zone A or beyond.

Default	false

test6=true | false

when set to True, requests a test for four out of five points in a row in Zone B or beyond.

Default	false

test7=true | false

when set to True, requests a test for fifteen points in a row in Zone C (above and below the center line).

Default	false

test8=true | false

when set to True, requests a test for eight points in a row on both sides of the center line with none in Zone C.

Default	false

processName="variable-name"

specifies the variable in the input data table that contains the names of processes to be analyzed.

Default	"processName"

processValue="variable-name"

specifies the variable in the input data table that contains the process measurements to be analyzed.

Default	"process"

sigmas=double

specifies the width of the control limits as a multiple of the standard error of the subgroup summary statistic.

Default	3
Minimum value (exclusive)	0

sMethod="RMSDF" | "RMVLUE" | "RNOWEIGHT" | "SMVLUE" | "SNOWEIGHT"

specifies the method of estimating the process standard deviation.

Default	SNOWEIGHT

RMSDF

requests a weighted root mean square estimate.

RMVLUE

requests a minimum variance linear unbiased estimate that is based on subgroup ranges.

RNOWEIGHT

requests an unweighted estimate that is based on subgroup ranges.

SMVLUE

requests a minimum variance linear unbiased estimate that is based on subgroup standard deviations.

SNOWEIGHT

requests an unweighted estimate that is based on subgroup standard deviations.

specsTable={castable}

specifies the specification limits data table and computes process capability indices.

For more information about specifying the specsTable parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

subgroupName="variable-name"

specifies the variable in the input data table that contains the names of subgroup variables.

Default	"subgroupName"

subgroupValue="variable-name"

specifies the variable in the input data table that contains the subgroup values.

Default	"subgroup"

* table={castable}

specifies the settings for an input table.

For more information about specifying the table parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

test2Run=integer

specifies the length of the pattern for Test 2.

Default	9

test3Run=integer

specifies the length of the pattern for Test 3.

Default	6

testNStd=true | false

when set to True, enables tests for special causes with varying subgroup sample sizes.

Default	false

testOverlap=true | false

when set to True, applies tests for special causes to overlapping patterns of points.

Default	false

boxChart Action

Produces box charts.

Python Syntax

results=s.spc.boxChart(

allN=True | False,

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

ciAlpha=double,

ciIndices=True | False,

"caseSensitive":True | False,

"exclude":True | False,

"excludeAll":True | False,

"keyIsPath":True | False,

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

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

"traceNames":True | False

exChart=True | False,

groupByLimit=64-bit-integer,

limitN=integer,

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

"name":"table-name"

"vars"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

no3SigmaCheck=True | False,

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

"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

pctlDef=integer,

"test1":True | False,

"test2":True | False,

"test3":True | False,

"test4":True | False,

"test5":True | False,

"test6":True | False,

"test7":True | False,

"test8":True | False

processName="variable-name",

processValue="variable-name",

sigmas=double,

sMethod="RMSDF" | "RMVLUE" | "RNOWEIGHT" | "SMVLUE" | "SNOWEIGHT",

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

}

subgroupName="variable-name",

subgroupValue="variable-name",

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

}

test2Run=integer,

test3Run=integer,

testNStd=True | False,

testOverlap=True | False

)

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
limitsTable	—	specifies the control limits data table.
specsTable	—	specifies the specification limits data table and computes process capability indices.
required parametertable	—	specifies the settings for an input table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
chartsTable	—	specifies the charts summary output data table.
outLimitsTable	—	specifies the output control limits data table.
outputTables	names	lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

allN=True | False

when set to True, includes all subgroups regardless of whether the subgroup sample size equals the nominal sample size.

Default	False

chartsTable={casouttable}

specifies the charts summary output data table.

For more information about specifying the chartsTable parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

ciAlpha=double

specifies the confidence level that is used to compute capability index confidence limits.

Default	0.05
Minimum value (exclusive)	0

ciIndices=True | False

when set to True, computes capability index confidence limits that are based on subgroup summary data.

Default	False

ciType="LOWER" | "TWOSIDED" | "UPPER"

specifies the type of confidence limits that are computed for capability indices: lower, upper, or two-sided.

Default	TWOSIDED

LOWER

requests lower confidence limits for capability indices.

TWOSIDED

requests two-sided confidence limits for capability indices.

UPPER

requests upper confidence limits for capability indices.

controlStat="MEAN" | "MEDIAN"

specifies whether box chart control limits are computed for subgroup means or subgroup medians.

Default	MEAN

MEAN

computes control limits for subgroup means.

MEDIAN

computes control limits for subgroup medians.

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

exChart=True | False

when set to True, includes a control chart in the results only when exceptions occur.

Default	False

groupByLimit=64-bit-integer

suppresses the analysis if the number of groups exceeds the specified value.

Minimum value	1

limitN=integer

specifies a nominal sample size for the control limits.

limitsTable={castable}

specifies the control limits data table.

For more information about specifying the limitsTable parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

medCentral="AVGMEAN" | "AVGMED" | "MEDMED"

specifies the method of estimating the process mean.

Default	AVGMED

AVGMEAN

uses the average of subgroup means to estimate the process mean.

AVGMED

uses the average of subgroup medians to estimate the process mean.

MEDMED

uses the median of subgroup medians to estimate the process mean.

no3SigmaCheck=True | False

when set to True, enables tests for special causes when the control limits are not three sigma limits.

Default	False

outLimitsTable={casouttable}

specifies the output control limits data table.

For more information about specifying the outLimitsTable parameter, see the common casouttable (Form 1) 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).

Alias	displayOut

pctlDef=integer

specifies the definition that is used to calculate percentiles in constructing box-and-whisker plots.

Default	5

primaryTests={tests}

requests one or more tests for special causes for the primary control chart.

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

"test1":True | False

when set to True, requests a test for one point beyond Zone A (outside the control limits).

Default	False

"test2":True | False

when set to True, requests a test for nine points in a row on one side of the center line.

Default	False

"test3":True | False

when set to True, requests a test for six points in a row steadily increasing or decreasing.

Default	False

"test4":True | False

when set to True, requests a test for fourteen points in a row alternating up and down.

Default	False

"test5":True | False

when set to True, requests a test for two out of three points in a row in Zone A or beyond.

Default	False

"test6":True | False

when set to True, requests a test for four out of five points in a row in Zone B or beyond.

Default	False

"test7":True | False

when set to True, requests a test for fifteen points in a row in Zone C (above and below the center line).

Default	False

"test8":True | False

when set to True, requests a test for eight points in a row on both sides of the center line with none in Zone C.

Default	False

processName="variable-name"

specifies the variable in the input data table that contains the names of processes to be analyzed.

Default	"processName"

processValue="variable-name"

specifies the variable in the input data table that contains the process measurements to be analyzed.

Default	"process"

sigmas=double

specifies the width of the control limits as a multiple of the standard error of the subgroup summary statistic.

Default	3
Minimum value (exclusive)	0

sMethod="RMSDF" | "RMVLUE" | "RNOWEIGHT" | "SMVLUE" | "SNOWEIGHT"

specifies the method of estimating the process standard deviation.

Default	SNOWEIGHT

RMSDF

requests a weighted root mean square estimate.

RMVLUE

requests a minimum variance linear unbiased estimate that is based on subgroup ranges.

RNOWEIGHT

requests an unweighted estimate that is based on subgroup ranges.

SMVLUE

requests a minimum variance linear unbiased estimate that is based on subgroup standard deviations.

SNOWEIGHT

requests an unweighted estimate that is based on subgroup standard deviations.

specsTable={castable}

specifies the specification limits data table and computes process capability indices.

For more information about specifying the specsTable parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

subgroupName="variable-name"

specifies the variable in the input data table that contains the names of subgroup variables.

Default	"subgroupName"

subgroupValue="variable-name"

specifies the variable in the input data table that contains the subgroup values.

Default	"subgroup"

* table={castable}

specifies the settings for an input table.

For more information about specifying the table parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

test2Run=integer

specifies the length of the pattern for Test 2.

Default	9

test3Run=integer

specifies the length of the pattern for Test 3.

Default	6

testNStd=True | False

when set to True, enables tests for special causes with varying subgroup sample sizes.

Default	False

testOverlap=True | False

when set to True, applies tests for special causes to overlapping patterns of points.

Default	False

boxChart Action

Produces box charts.

R Syntax

results <– cas.spc.boxChart(s,

allN=TRUE | FALSE,

=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", ...>)

ciAlpha=double,

ciIndices=TRUE | FALSE,

=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

exChart=TRUE | FALSE,

groupByLimit=64-bit-integer,

limitN=integer,

=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(...)>),

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

singlePass=TRUE | FALSE,

vars

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

where="where-expression",

whereTable

=list(

casLib="string"

name="table-name"

vars

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

no3SigmaCheck=TRUE | FALSE,

=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", ...>)

=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

pctlDef=integer,

=list(

test1=TRUE | FALSE,

test2=TRUE | FALSE,

test3=TRUE | FALSE,

test4=TRUE | FALSE,

test5=TRUE | FALSE,

test6=TRUE | FALSE,

test7=TRUE | FALSE,

test8=TRUE | FALSE

processName="variable-name",

processValue="variable-name",

sigmas=double,

sMethod="RMSDF" | "RMVLUE" | "RNOWEIGHT" | "SMVLUE" | "SNOWEIGHT",

=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(...)>),

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

singlePass=TRUE | FALSE,

vars

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

where="where-expression",

whereTable

=list(

casLib="string"

name="table-name"

vars

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

subgroupName="variable-name",

subgroupValue="variable-name",