dataPreprocess

histogram

Description

Generates histogram bins and simple bin-based statistics for numeric variables.

dataPreprocess.histogram <result=results> <status=rc> / <casOutBinDetails={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">}}>, <freq="variable-name">, <includeMissingGroup=TRUE | FALSE>, <inputs={{format="string", formattedLength=integer, label="string", name="variable-name", nfd=integer, nfl=integer} <, {...}>}>, <maxIterations=integer>, <nArgumentsForEachVar={integer-1 <, integer-2>}>, <outputTableOptions={forceTableReturn=TRUE | FALSE, tableNames={"string-1" <, "string-2">}}>, <percentileDefinition=integer>, <percentileMaxIterations=integer>, <percentileTolerance=double>, <requestPackages={{allScaleTypes=TRUE | FALSE, binEnd=double, binMapping="LEFT" | "RIGHT", binOutliers=TRUE | FALSE, binStart=double, binWidth=double, cutPoints={double-1 <, double-2>}, emptyBins=TRUE | FALSE, globalBinWidth=TRUE | FALSE, globalNObs="AVERAGE" | "MAX" | "MIN", integerBinning=TRUE | FALSE, integerBinningLimit=integer, method="CUTPTS" | "EQUALFREQ" | "EQUALWIDTH", nBins=integer, niceBinning=TRUE | FALSE, outlierArguments={aadLocationUseMean=TRUE | FALSE, location="BIWEIGHT" | "GEOMETRICMEAN" | "HARMONICMEAN" | "MEAN" | "MEDIAN" | "TRIMMEDMEAN" | "WINSORIZEDMEAN", locationBiweightTuning=double, lowerPercentile=double, max=double, min=double, replacements={"BIWEIGHT", "GEOMETRICMEAN", "HARMONICMEAN", "MEAN", "MEDIAN", "TRIMMEDMEAN", "WINSORIZEDMEAN"} | {double-1 <, double-2>}, scale="AAD" | "BIWEIGHT" | "GINI" | "IQR" | "MAD" | "STD", scaleBiweightTuning=double, scaleMultiplier=double, symmetricPercentile=double, upperPercentile=double, userDefinedLimits={double-1 <, double-2>}, zScoreThreshold=double}, outlierMethod="IQR" | "MIQR" | "MZSCORE" | "PERC" | "UDFLIMITS" | "ZSCORE", outlierTreatment="REPLACE" | "TRIM" | "WINSOR", round=TRUE | FALSE, roundFactor=double, roundType="DOWN" | "NEAREST" | "UP", scaleType="DENSITY" | "PERCENT" | "PROPORTION"} <, {...}>}>, 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"}>, <tolerance=double>, <varsToArgumentsMap={integer-1 <, integer-2>}>, <weight="variable-name">;
Settings
ParameterDescription
casOutBinDetailsspecifies the settings for an output table. For more information about specifying the casOutBinDetails parameter, see the common casouttable parameter. Alias: casOut.
freqspecifies the frequency variable. Alias: frequency.
includeMissingGroupwhen set to True, missing values are allowed as group-by keys. Default: FALSE.
inputsspecifies the variables to use for the analysis. You can specify a subset of the variables from the input table. For more information about specifying the inputs parameter, see the common casinvardesc parameter. Alias: vars. It includes sub-parameters: format, formattedLength, label, name (required), nfd, nfl.
maxIterationsspecifies the maximum number of iterations for the iterative robust univariate statistics such as MAD scale, GINI scale, and Medcouple skewness estimates. This parameter can be used if the ZSCORE outlier definition is used. Aliases: maxIters, rustatsMaxNiters.
nArgumentsForEachVarspecifies the number of arguments (request packages) for each variable. If not set, then all request packages are included for all variables.
outputTableOptionsspecifies options for result tables. You can specify which result tables the server returns and how group-by results are handled. Alias: tblOpts. It includes sub-parameters: forceTableReturn (default: FALSE), tableNames (Alias: outputTables).
percentileDefinitionspecifies the percentile definition to use. The definitions are numbered 1 to 6. The default value is 6. Alias: pctlDef. Range: 1–6.
percentileMaxIterationsspecifies the maximum number of iterations for percentile computation. Alias: pctlMaxIters.
percentileTolerancespecifies the tolerance for percentile computation. Alias: pctlEpsilon. Default: 1E-05.
requestPackagesspecifies an array of histogram request packages to be processed by the action. You can match request packages to analysis variables with the nArgsForEachVar and varsToArgsMap parameters. Alias: reqPacks. It includes sub-parameters: allScaleTypes (default: FALSE), binEnd, binMapping (default: RIGHT), binOutliers (default: FALSE), binStart, binWidth, cutPoints (Alias: cutPts), emptyBins (default: TRUE), globalBinWidth (default: FALSE), globalNObs ("AVERAGE" | "MAX" | "MIN"), integerBinning (Alias: intBinning, default: TRUE), integerBinningLimit (Alias: intBinningLim, default: 16), method ("CUTPTS" | "EQUALFREQ" | "EQUALWIDTH", Alias: type, default: EQUALWIDTH), nBins, niceBinning (default: TRUE), outlierArguments (specifies the outlier definition and treatment. It includes sub-parameters: aadLocationUseMean (Alias: aadLocUseMean, default: TRUE), location ("BIWEIGHT" | "GEOMETRICMEAN" | "HARMONICMEAN" | "MEAN" | "MEDIAN" | "TRIMMEDMEAN" | "WINSORIZEDMEAN", default: MEAN), locationBiweightTuning (Alias: locBiweightTuning, Minimum value (exclusive): 0), lowerPercentile (Alias: lowerPerc, Range: (0, 50)), max, min, replacements ({"BIWEIGHT", "GEOMETRICMEAN", "HARMONICMEAN", "MEAN", "MEDIAN", "TRIMMEDMEAN", "WINSORIZEDMEAN"} | {double-1 <, double-2>}), scale ("AAD" | "BIWEIGHT" | "GINI" | "IQR" | "MAD" | "STD", default: STD), scaleBiweightTuning (Alias: sclBiweightTuning, Minimum value (exclusive): 0), scaleMultiplier, symmetricPercentile (Alias: symPerc, Range: (0, 100)), upperPercentile (Alias: upperPerc, Range: (50, 100)), userDefinedLimits ({double-1 <, double-2>}), zScoreThreshold), outlierMethod ("IQR" | "MIQR" | "MZSCORE" | "PERC" | "UDFLIMITS" | "ZSCORE"), outlierTreatment ("REPLACE" | "TRIM" | "WINSOR"), round (default: FALSE), roundFactor, roundType ("DOWN" | "NEAREST" | "UP"), scaleType ("DENSITY" | "PERCENT" | "PROPORTION", default: PERCENT).
tablespecifies the table name, caslib, and other common parameters. For more information about specifying the table parameter, see the common castable parameter. It includes sub-parameters: caslib, computedOnDemand, computedVars (includes sub-parameters: format, formattedLength, label, name (required), nfd, nfl), computedVarsProgram, dataSourceOptions, groupBy (includes sub-parameters: format, formattedLength, label, name (required), nfd, nfl), groupByMode, importOptions, name (required), orderBy (includes sub-parameters: format, formattedLength, label, name (required), nfd, nfl), singlePass, vars (includes sub-parameters: format, formattedLength, label, name (required), nfd, nfl), where, whereTable (includes sub-parameters: casLib, dataSourceOptions, importOptions, name (required), vars, where).
tolerancespecifies the tolerance for the iterative robust univariate statistics. Default: 1E-05.
varsToArgumentsMapspecifies which request packages to compute for each variable. If a value is specified for the nArgsForEachVar parameter, then you must set this. Otherwise, both parameters are ignored and all request packages are computed for all variables.
weightspecifies the weight variable.
Data Preparation View data prep sheet
No explicit data creation example found

The provided HTML documentation does not contain a specific section or example dedicated to data creation for this action.

Copied!
1/* No
2data creation code provided in the documentation. */

Examples

FAQ

What is the histogram Action?
What is the purpose of the casOutBinDetails parameter?
What does the freq parameter do?
What is the function of the includeMissingGroup parameter?
What are the inputs parameters used for?
What is the maximum number of iterations for maxIterations parameter?
What is the purpose of the nArgumentsForEachVar parameter?
What are the outputTableOptions parameters for?
What is forceTableReturn in outputTableOptions?
What are tableNames in outputTableOptions?
What does percentileDefinition parameter control?
What does percentileMaxIterations parameter specify?
What is the percentileTolerance parameter?
What are requestPackages used for?
What does allScaleTypes in requestPackages do?
What is binEnd in requestPackages?
How does binMapping in requestPackages work?
What does binOutliers in requestPackages do?
What is binStart in requestPackages?
What is binWidth in requestPackages?
What are cutPoints in requestPackages?
What does emptyBins in requestPackages do?
What does globalBinWidth in requestPackages do?
What is globalNObs in requestPackages?
What does integerBinning in requestPackages control?
What is integerBinningLimit in requestPackages?
What are the available methods for histogram generation in requestPackages?
What does nBins in requestPackages specify?
What does niceBinning in requestPackages control?
What are outlierArguments in requestPackages?
What does aadLocationUseMean in outlierArguments do?
What are the location estimation methods in outlierArguments?
What is locationBiweightTuning in outlierArguments?
What is lowerPercentile in outlierArguments?
What does max in outlierArguments specify?
What does min in outlierArguments specify?
What are the replacement values in outlierArguments?
What are the scale methods in outlierArguments?
What is scaleBiweightTuning in outlierArguments?
What is scaleMultiplier in outlierArguments?
What is symmetricPercentile in outlierArguments?
What is upperPercentile in outlierArguments?
What are userDefinedLimits in outlierArguments?
What is zScoreThreshold in outlierArguments?
What are the outlier definition methods in requestPackages?
How are outliers treated in requestPackages?
What does round in requestPackages do?
What is roundFactor in requestPackages?
What is roundType in requestPackages?
What are the scaleType options in requestPackages?
What is the required table parameter for?
What is tolerance parameter for?
What is varsToArgumentsMap parameter for?
What is the weight parameter for?