Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Op Functions Val Parameters

brandonherzog edited this page Apr 14, 2017 · 5 revisions

Table of Contents

Op Functions

These functions are designed to retrieve raw data or statistics from cells that have Argo distributions or results defined in them.

op(Distribution):

Returns the probability distribution samples as an array. Distribution is an Argo probability distribution or Results. Deprecated - use OpData instead.

opAveDev(Distribution):

Returns the average of the absolute deviations of the probability distribution samples from their average. Distribution is an Argo probability Distribution or Result

opAverage(Distribution):

Returns the average of the probability distribution samples.

opCorr(Distribution, Distribution, Type[OPTIONAL]):

Returns the correlation coefficient between two probability distribution samples. Both Distribution parameters are Argo probability distributions or results. Type specifies the correlation method; True = Pearson (linear), False = Spearman (rank). Defaults to True if omitted.

opCorrMat(Distributions, Type[OPTIONAL]):

Returns the matrix of correlation coefficients for two or more probability distributions. Distribution is an Argo probability Distribution or Result. Type specifies the correlation method; True = Pearson (linear), False = Spearman (rank). Defaults to True if omitted.

opCorrMatAdjusted(Matrixdefinition):

Returns the adjusted rank correlation matrix. Returned matrix represents the nearest valid matrix to the defined matrix. The returned matrix will equal defined matrix if defined matrix is valid. Matrixdefinition is a cell containing a RtaCorrMatDefine formula.

opCount(Distribution):

Returns the count of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opCV(Distribution):

Returns the coefficient of variation of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opData(Distribution, Orientation[OPTIONAL]):

Returns the probability distribution samples as an array. Distribution is an Argo probability Distribution or Result. Orientation determines the orientation of the return array; True Returns column array, False Returns row array. True if omitted

opExpGain(Distribution):

Returns the average of all values greater than 0 then multiplies the product by 1 - (percentage from 0) among all data. Distribution is an Argo probability Distribution or Result.

opExpGainRatio(Distribution):

Returns the semi variance of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opExpLoss(Distribution):

Returns the average of all values less than 0 then multiplies the product by 1 - (percentage from 0) among all data. Distribution is an Argo probability Distribution or Result.

opExpLossRation(Distribution):

Returns the expected loss ratio for a specified indefinite function. Distribution is an Argo probability Distribution or Result.

opExpValMargin(Distribution):

Returns ExpGainRatio - ExpLoss Ratio. Distribution is an Argo probability Distribution or Result.

opFrequency(Distribution):

Returns how often samples of the probability distribution occur within a range of values. Distribution is an Argo probability Distribution or Result. Bin is an array of, or reference to, intervals to group the probability distribution's samples.

opKurt(Distribution):

Returns the kurtosis of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opMax(Distribution):

Returns the max of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opMedian(Distribution):

Returns the median of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opMin(Distribution):

Returns the min of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opMode(Distribution):

Returns the mode of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opPercentile(Distribution):

Returns the kth percentile of the probability distribution samples. Distribution is an Argo probability Distribution or Result. K is the kth percentile value; must be a value between 0 and 1

opPercentInterval(Distribution, Lower, Upper):

Returns the percentage of the distribution that falls in the provided range (Lower <= x <= Upper). Distribution is an Argo probability Distribution or Result. Lower is the lower value of the range. Upper is the upper value of the range.

opPercentRank(Distribution, X):

Returns the rank of a value in a probability distribution's samples as a percentage of the samples. Distribution is an Argo probability Distribution or Result. X is the value in question.

opRange(Distribution):

Returns the range of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opSemiDev(Distribution, Target, Downside[OPTIONAL]):

Returns the semi deviation of the probability distribution samples. Distribution is an Argo probability Distribution or Result. Target is the threshold delineating the scenarios that represent a risk. Downside is whether the scenario of interest is below the target; True if below, False if above. Defaults to True if omitted.

opSemiVar(Distribution, Target, Downside[OPTIONAL]):

Returns the semi variance of the probability distribution samples. Distribution is an Argo probability Distribution or Result. Target is the threshold delineating the scenarios that represent a risk. Downside is whether the scenario of interest is below the target; True if below, False if above. Defaults to True if omitted.

opSigmaCP(Distribution, Lower, X):

Returns the capability of the process around a target value. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. X is the largest number that can belong to the different classes.

opSigmaCPK(Distribution, Lower, Upper):

Returns what the process is capable of producing if the process mean is not centered between the lower and upper limits. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Upper is the largest numbers that can belong to the different classes.

opSigmaCPKLower(Distribution, Lower):

Returns the one-sided Process Capability Index based on the lower specified limit. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes.

opSigmaCPKUpper(Distribution, Upper):

Returns the one-sided Process Capability Index based on the upper specified limit. Distribution is an Argo probability Distribution or Result. Upper is the largest numbers that can belong to the different classes.

opSigmaCPM(Distribution, Lower, Upper, Target):

Returns the capability of the process around a target value. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Upper is the largest numbers that can belong to different classes. Target is the target value.

opSigmaDefectPPM(Distribution, Lower, Upper):

Returns the Defective Parts per Million. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Upper is the largest numbers that can belong to the different classes.

opSigmaDefectShiftPPM(Distribution, Lower, Upper, Shift):

Returns the Defective Parts per Million with an added shift. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Upper is the largest numbers that can belong to the different classes. Shift is the shift value.

opSigmaDefectShiftPPMLower(Distribution, Lower, Shift):

Returns the Defective Parts per Million with a shift below the lower specified limit. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. . Shift is the shift value.

opSigmaDefectShiftPPMUpper(Distribution, Upper, Shift):

Returns the Defective Parts per Million with a shift above the upper specified limit. Distribution is an Argo probability Distribution or Result. Upper is the largest numbers that can belong to the different classes. Shift is the shift value.

opSigmaK(Distribution, Lower, Upper):

Returns the measure of the distribution center. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Upper is the largest numbers that can belong to the different classes.

opSigmaLowerbound(Distribution, N):

Returns the lower bound as a specific number of standard deviations below the mean. Distribution is an Argo probability Distribution or Result. N is the number of standard deviations.

opSigmaProbDefectShift(Distribution, Lower, Upper, Shift):

Returns the Probability of Defect with a shift outside of the upper and lower limits. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Upper is the largest numbers that can belong to the different classes. Shift is the shift value.

opSigmaProbDefectShiftLower (Distribution, Lower, Shift):

Returns the Probability of Defect, with a shift, outside of the lower limit. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Shift is the shift value.

opSigmaProbDefectShiftUpper (Distribution, Upper, Shift):

Returns the Probability of Defect, with a shift, outside of the upper limit. Distribution is an Argo probability Distribution or Result. Upper is the largest numbers that can belong to the different classes. Shift is the shift value.

opSigmaSigmaLevel(Distribution, Lower, Upper, Shift):

Returns the Process Sigma Level with a shift. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Upper is the largest numbers that can belong to the different classes. Shift is the shift value.

opSigmaUpperbound(Distribution, N):

Returns the upper bound as a specific number of standard deviations above the mean. Distribution is an Argo probability Distribution or Result. N is the number of standard deviations.

opSigmaYield(Distribution, Lower, Upper, Shift):

Returns the Six Sigma Yield, with a shift, or the fraction of the process that is free of defects. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Upper is the largest numbers that can belong to the different classes. Shift is the shift value.

opSigmaZLower(Distribution, N):

Returns the number of standard deviations of the process that the lower limit is below the mean of the process. Distribution is an Argo probability Distribution or Result. N is the number of standard deviations.

opSigmaZMin(Distribution, Lower, Upper):

Returns the minimum of opSigmaZLower and opSigmaZUpper. Distribution is an Argo probability Distribution or Result. Lower is the smallest numbers that can belong to the different classes. Upper is the largest numbers that can belong to the different classes.

opSigmaZUpper(Distribution, N):

Returns the number of standard deviations of the process that the upper limit is above the mean of the process. Distribution is an Argo probability Distribution or Result. N is the number of standard deviations.

opSkew(Distribution):

Returns the skewness of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opStDev(Distribution):

Returns the standard deviation of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

opVar(Distribution):

Returns the variance of the probability distribution samples. Distribution is an Argo probability Distribution or Result.

Val Parameters

Val parameters are optional parameters used in a Argo distribution formula. To use a val parameter, add it as a parameter in your formula (i.e. rtaNormal(0,1,valName("My Distribution"),valShift(1))). Note you can use more than one val parameter.

ValCorrMatApply(MatrixDefinition, Position):

An optional parameter that includes this distribution in a defined rAnk correlation matrix. MatrixDefinition is a cell containing a RtaCorrMatDefine formula. Position is this distribution's index in the rAnk correlation matrix.

ValLikelihood(Likelihood):

An optional parameter that specifies the uncertain input's likelihood of occurrence. Likelihood is the likelihood that the uncertain input will occur (between 0.0 And 1.0).

ValLowerBound(Lowerbound):

An optional parameter that specifies the uncertain input's lowerbound. Lowerbound is the real number lowerbound of the uncertain input.

ValName(Name):

An optional parameter that specifies the uncertain input's name. Name is the name of the uncertain input.

ValPointEstimate(PointEstimate):

An optional parameter that forces the RTA function to return a single value to the worksheet instead of a rAndom draw. PointEstimate is the real number value to be returned by the function to the worksheet.

ValShift(Shift):

An optional parameter that shifts the uncertain input's location along the unit axis. Shift is the real number value to shift the location of the uncertain input.

ValUpperBound(Upperbound):

An optional parameter that specifies the uncertain input's upperbound. Upperbound is the real number upperbound of the uncertain input.