Libraries.Compute.Statistics.Reporting.PrincipalComponentAnalysisResult Documentation
This class represents data that comes back from a principal component analysis in a PrincipalComponentAnalysis statistical test.
Inherits from: Libraries.Language.Object
Actions Documentation
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Example
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Converged()
Returns the flag of whether convergence was reached within the max iterations in rotation, if a rotation occurred.
Return
boolean:
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
Example
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
GetCommunality()
GetComponentRotation()
Returns the rotation object, if a rotation occurred.
Return
GetCorrelationMatrix()
Returns the correlation matrix (known sometimes as phi) from the rotation calculations, if a rotation occurred.
Return
GetDegreesOfFreedom()
Obtains the degrees of freedom value (df in statistics) of the model calculated by the test.
Return
number:
GetEigenvalues()
GetEigenvectors()
GetEpsilon()
Returns the epsilon value used in rotation, if a rotation occurred.
Return
number:
GetFactorLoadings()
Returns the rotated component factor loadings dataframe from the rotation, if a rotation occurred.
Return
GetFormalNumericalResult()
This action returns the formal numrical result in APA format. For more information: https://apastyle.apa.org/instructional-aids/numbers-statistics-guide.pdf
Return
text:
GetFormalSummary()
This action summarizes the result and places it into formal academic language, in APA format. For more information: https://apastyle.apa.org/instructional-aids/numbers-statistics-guide.pdf
Return
text:
GetFormalTestName()
Returns the name of the test in formal mathematical language.
Return
text: the name of the test in mathematical language.
GetFormat()
Returns the statistical format for the output in the summary or formal summary.
Return
Libraries.Compute.Statistics.Reporting.StatisticsFormatting:
GetHashCode()
This action gets the hash code for an object.
Return
integer: The integer hash code of the object.
Example
Object o
integer hash = o:GetHashCode()
GetItemComplexity()
For more information: https://files.eric.ed.gov/fulltext/ED074155.pdf
Return
GetIterations()
Returns the number of iterations that actually occurred during a rotation, if a rotation occurred.
Return
integer:
GetMaximumIterations()
Returns the maximum number of iterations that can occur during a rotation, if a rotation occurs.
Return
integer:
GetMeanItemComplexity()
Returns the mean value of all the hoffman complexities.
Return
number:
GetModelFit()
This is computed as (upper triangle of residuals) / (upper triangle of original correlations) - 1.0
Return
number:
GetProbabilityValue()
Obtains the probability value (p in statistics) of the model calculated by the test.
Return
number:
GetProportionExplained()
GetProportionVariance()
GetReportDiv()
GetReportResult(Libraries.System.File file)
GetResidualHistogram()
Returns the histogram chart that shows the upper triangle of the residuals.
Return
GetResiduals()
GetRootMeanSquareOfResiduals()
If a covariance matrix was used for PCA, this is the non-standardized rmsr
Return
number:
GetRotation()
Returns the type of component rotation that took place if any.
Return
text:
GetRotationMatrix()
Returns the rotation matrix from the rotation calculations, if a rotation occurred.
Return
GetScreePlot()
Returns the scree plot chart that plots all eigenvalues.
Return
GetStructureLoadings()
This can be calculated by the dot product between loadings and the correlation matrix (phi) from the rotation
Return
GetSummary()
This action summarizes the result and lists it informally.
Return
text:
GetTestStatistic()
This indicates the test statistic of the model for the test that was run
Return
number:
GetUniqueness()
GetVarianceAccountedFor()
When an oblique rotation occurs, these are the diagonal values from S'C where S is the structure matrix, and C is the rotated component loadings
Return
Normalize()
Returns the flag of whether Kaiser normalization was applied to the rotation, if a rotation occurred.
Return
boolean:
SetCommunality(Libraries.Compute.Vector communality)
SetComponentRotation(Libraries.Compute.Statistics.Transforms.ComponentRotation rotation)
Stores the rotation object, if a rotation occurred.
Parameters
SetDegreesOfFreedom(number degreesOfFreedom)
Sets the degrees of freedom value (df in statistics) of the model calculated by the test.
Parameters
- number degreesOfFreedom
SetEigenvalues(Libraries.Compute.Vector eigenvalues)
SetEigenvectors(Libraries.Containers.Array<Libraries.Compute.Vector> eigenvectors)
SetFactorLoadings(Libraries.Compute.Statistics.DataFrame factorLoadings)
Stores the rotated component factor loadings dataframe from the rotation, if a rotation occurred.
Parameters
SetFormalTestName(text formalTestName)
Sets the name of the test in formal mathematical language.
Parameters
- text formalTestName: the name of the test in mathematical language.
SetFormat(Libraries.Compute.Statistics.Reporting.StatisticsFormatting format)
Stores the statistical format for the output in the summary or formal summary.
Parameters
SetItemComplexity(Libraries.Compute.Vector complexity)
For more information: https://files.eric.ed.gov/fulltext/ED074155.pdf
Parameters
SetMeanItemComplexity(number meanComplexity)
Stores the mean value of all the hoffman complexities.
Parameters
- number meanComplexity
SetModelFit(number modelFit)
This is computed as sumofsquares(upper triangle of residuals) / sumofsquares(upper triangle of original correlations) - 1.0
Parameters
- number modelFit
SetObliqueRotation(boolean obliqueRotation)
Stores what type of rotation was used, if a rotation occurred.
Parameters
- boolean obliqueRotation
SetOrthogonalRotation(boolean orthogonalRotation)
Stores what type of rotation was used, if a rotation occurred.
Parameters
- boolean orthogonalRotation
SetProbabilityValue(number probabilityValue)
Sets the probability value (p in statistics) of the model calculated by the test.
Parameters
- number probabilityValue
SetProportionExplained(Libraries.Compute.Vector proportionExplained)
SetProportionVariance(Libraries.Compute.Vector proportionVariance)
SetResiduals(Libraries.Compute.Statistics.DataFrame residuals)
SetRootMeanSquareOfResiduals(number rootMeanSquareOfResiduals)
If a covariance matrix was used for PCA, this is the non-standardized rmsr
Parameters
- number rootMeanSquareOfResiduals
SetTestStatistic(number testStatistic)
This sets the calculated test statistic of the model for the test that was run
Parameters
- number testStatistic
SetUniqueness(Libraries.Compute.Vector uniqueness)
SetVarianceAccountedFor(Libraries.Compute.Vector varianceAccountedFor)
When an oblique rotation occurs, these are the diagonal values from S'C where S is the structure matrix, and C is the rotated component loadings
Parameters
On this page
Variables TableAction Documentation- Compare(Libraries.Language.Object object)
- Converged()
- Equals(Libraries.Language.Object object)
- GetCommunality()
- GetComponentRotation()
- GetCorrelationMatrix()
- GetDegreesOfFreedom()
- GetEigenvalues()
- GetEigenvectors()
- GetEpsilon()
- GetFactorLoadings()
- GetFormalNumericalResult()
- GetFormalSummary()
- GetFormalTestName()
- GetFormat()
- GetHashCode()
- GetItemComplexity()
- GetIterations()
- GetMaximumIterations()
- GetMeanItemComplexity()
- GetModelFit()
- GetProbabilityValue()
- GetProportionExplained()
- GetProportionVariance()
- GetReportDiv()
- GetReportResult(Libraries.System.File file)
- GetResidualHistogram()
- GetResiduals()
- GetRootMeanSquareOfResiduals()
- GetRotation()
- GetRotationMatrix()
- GetScreePlot()
- GetStructureLoadings()
- GetSummary()
- GetTestStatistic()
- GetUniqueness()
- GetVarianceAccountedFor()
- Normalize()
- SetCommunality(Libraries.Compute.Vector communality)
- SetComponentRotation(Libraries.Compute.Statistics.Transforms.ComponentRotation rotation)
- SetDegreesOfFreedom(number degreesOfFreedom)
- SetEigenvalues(Libraries.Compute.Vector eigenvalues)
- SetEigenvectors(Libraries.Containers.Array
eigenvectors) - SetFactorLoadings(Libraries.Compute.Statistics.DataFrame factorLoadings)
- SetFormalTestName(text formalTestName)
- SetFormat(Libraries.Compute.Statistics.Reporting.StatisticsFormatting format)
- SetItemComplexity(Libraries.Compute.Vector complexity)
- SetMeanItemComplexity(number meanComplexity)
- SetModelFit(number modelFit)
- SetObliqueRotation(boolean obliqueRotation)
- SetOrthogonalRotation(boolean orthogonalRotation)
- SetProbabilityValue(number probabilityValue)
- SetProportionExplained(Libraries.Compute.Vector proportionExplained)
- SetProportionVariance(Libraries.Compute.Vector proportionVariance)
- SetResiduals(Libraries.Compute.Statistics.DataFrame residuals)
- SetRootMeanSquareOfResiduals(number rootMeanSquareOfResiduals)
- SetTestStatistic(number testStatistic)
- SetUniqueness(Libraries.Compute.Vector uniqueness)
- SetVarianceAccountedFor(Libraries.Compute.Vector varianceAccountedFor)