pgu.normDist: pgu.normDist
In pguIMP: 'pguIMP'
Description
Format
Details
Active bindings
Methods
Author(s)
Description
Compares the distribution of a single attribute's values to normal distribution
by using several statistic tests.
Format
R6::R6Class object.
Details
The distribution of a single value is tested for normality by
Shapiro-Wilk test, Kolmogorov-Smirnov test, Anderson-Darling test.
The expectation value and standard deviation of a normal distribution
representing the data are determined by maximizing the log Likelihood
with respect to the expectation value and standard deviation.
This object is used by the shiny based gui and is not for use in individual R-scripts!
Active bindings
featureNameReturns the instance variable featureName.
(character)
rawDataReturns the instance variable rawData.
(tibble::tibble)
setRawDataSets the instance variable rawData.
(tibble::tibble)
histogramReturns the instance variable histogram.
(tibble::tibble)
expMuReturns the instance variable expMu.
(numeric)
expSigmaReturns the instance variable expSigma.
(numeric)
dataPointsReturns the instance variable dataPoints.
(numeric)
logLikelihoodReturns the instance variable logLikelihood.
(numeric)
degOfFreedomReturns the instance variable degOfFreedom.
(numeric)
nReturns the instance variable n.
(integer)
bicReturns the instance variable bic.
(numeric)
aicReturns the instance variable aic.
(numeric)
aiccReturns the instance variable aicc.
(numeric)
rmseReturns the instance variable rmse.
(numeric)
fitSuccessReturns the instance variable fitSuccess.
(logical)
testNamesReturns the instance variable testNames.
(character)
testParameterNamesReturns the instance variable testParameterNames.
(character)
alphaReturns the instance variable alpha.
(numeric)
w.shapiroReturns the instance variable w.shapiro.
(numeric)
p.shapiroReturns the instance variable p.shapiro.
(numeric)
d.kolmogorowReturns the instance variable d.kolmogorow.
(numeric)
p.kolmogorowReturns the instance variable p.kolmogorow.
(numeric)
a.andersonReturns the instance variable a.anderson.
(numeric)
p.andersonReturns the instance variable p.anderson.
(numeric)
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Method new()
Creates and returns a new pgu.normDist object.
Usage
pgu.normDist$new(data = "tbl_df")
Arguments
dataThe data to be analyzed.
(tibble::tibble)
Returns
A new pgu.normDist object.
(pguIMP::pgu.normDist)
Method finalize()
Clears the heap and
indicates that instance of pgu.normDist is removed from heap.
Usage
pgu.normDist$finalize()
Method print()
Prints instance variables of a pgu.normDist object.
Usage
pgu.normDist$print()
Returns
string
Method resetNormDist()
Resets instance variables
Usage
pgu.normDist$resetNormDist(data = "tbl_df")
Arguments
dataDataframe to be analyzed.
(tibble::tibble)
Method resetFail()
Resets instance variables in case of a failed analysis.
Usage
pgu.normDist$resetFail()
Method optimize()
Optimizes the logLikelihood between the data and a normal distribution
with respect to the expectation value and standard deviation.
The quality of the best model ist calculated subsequently.
Usage
pgu.normDist$optimize()
Method createHistogram()
Creates a histogram from the instance variable rawData.
The histogram is stored in the instance variable histogram.
Usage
pgu.normDist$createHistogram()
Method normalQQData()
Performes a qq-analysis of the instance variable rawData
The qq-analysis is stored in the attributes sample_quantile
and theoretical_quantile of the instance variable rawData.
Usage
pgu.normDist$normalQQData()
Method test.shapiro()
Performes Shapiro-Wilk's test for normality on the
instance variable rawData.
The test result is stored in the instance variable
w.shapiro.
The p-value of the test is stored in the instance variable
p.shapiro
Usage
pgu.normDist$test.shapiro()
Method test.kolmogorow()
Performes Kolmogorow-Smirnow's test for normality on the
instance variable rawData.
The test result is stored in the instance variable
d.kolmogorow.
The p-value of the test is stored in the instance variable
p.kolmogorow
Usage
pgu.normDist$test.kolmogorow()
Method test.anderson()
Performes Anderson-Darling's test for normality on the
instance variable rawData.
The test result is stored in the instance variable
a.anderson.
The p-value of the test is stored in the instance variable
p.anderson
Usage
pgu.normDist$test.anderson()
Method fitResult()
Returns the result of the classes optimize function
in form of a formated string.
Usage
pgu.normDist$fitResult()
Returns
String of the results of the fitting routine
(character)
Method testResult()
Returns the result of the classes test functions
in form of a formated string.
Usage
pgu.normDist$testResult(testName = "Shapiro-Wilk")
Arguments
testNameDefines the test which result shall be returned.
Can be of type:Shapiro-Wilk, Kolmogorow-Smirnow
or Anderson-Darling.
(character)
Returns
String of the results of the testing routine
(character)
Method testResultCompendium()
Returns the result of the classes test functions
Shapiro-Wilk, Kolmogorow-Smirnow and
Anderson-Darling
in form of a formated string.
(character)
Usage
pgu.normDist$testResultCompendium()
Returns
String of the results of the testing routine
(character)
Method plotHistogram()
Displays the instance variable histogram
in form of a bar plot and overlays the corresponding normal distribution.
Usage
pgu.normDist$plotHistogram()
Returns
A bar plot.
(ggplot2::ggplot)
Method plotResiduals()
Displays the residuals between the instance variable
histogram and the corresponding normal distribution.
Usage
pgu.normDist$plotResiduals()
Returns
A scatter plot.
(ggplot2::ggplot)
Method plotResidualDist()
Displays the distribution of the residuals between the distribution of the instance variable
histogram in form of a histogram.
Usage
pgu.normDist$plotResidualDist()
Returns
A bar plot.
(ggplot2::ggplot)
Method plotRawResidualDist()
Displays the distribution of the residuals between the distribution of the instance variable
rawData in form of a histogram.
Usage
pgu.normDist$plotRawResidualDist()
Returns
A bar plot.
(ggplot2::ggplot)
Method plotRawDataDist()
Displays the distribution of the instance variable
rawData in form of a histogram.
Usage
pgu.normDist$plotRawDataDist()
Returns
A bar plot.
(ggplot2::ggplot)
Method normalQQPlot()
Displays a qqplot of the instance variable
rawData.
Usage
pgu.normDist$normalQQPlot()
Returns
A qq-plot.
(ggplot2::ggplot)
Method fit()
Runs the optimization process and performs all implemented quality controls.
Additionally performs hypothesis tests for nromality.
Usage
pgu.normDist$fit()
Method clone()
The objects of this class are cloneable with this method.
Usage
pgu.normDist$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Author(s)
Sebastian Malkusch, malkusch@med.uni-frankfurt.de
pguIMP documentation built on Sept. 30, 2021, 5:08 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Format Details Active bindings Methods Author(s)
Description
Compares the distribution of a single attribute's values to normal distribution by using several statistic tests.
Format
R6::R6Class object.
Details
The distribution of a single value is tested for normality by Shapiro-Wilk test, Kolmogorov-Smirnov test, Anderson-Darling test. The expectation value and standard deviation of a normal distribution representing the data are determined by maximizing the log Likelihood with respect to the expectation value and standard deviation. This object is used by the shiny based gui and is not for use in individual R-scripts!
Active bindings
featureNameReturns the instance variable featureName. (character)
rawDataReturns the instance variable rawData. (tibble::tibble)
setRawDataSets the instance variable rawData. (tibble::tibble)
histogramReturns the instance variable histogram. (tibble::tibble)
expMuReturns the instance variable expMu. (numeric)
expSigmaReturns the instance variable expSigma. (numeric)
dataPointsReturns the instance variable dataPoints. (numeric)
logLikelihoodReturns the instance variable logLikelihood. (numeric)
degOfFreedomReturns the instance variable degOfFreedom. (numeric)
nReturns the instance variable n. (integer)
bicReturns the instance variable bic. (numeric)
aicReturns the instance variable aic. (numeric)
aiccReturns the instance variable aicc. (numeric)
rmseReturns the instance variable rmse. (numeric)
fitSuccessReturns the instance variable fitSuccess. (logical)
testNamesReturns the instance variable testNames. (character)
testParameterNamesReturns the instance variable testParameterNames. (character)
alphaReturns the instance variable alpha. (numeric)
w.shapiroReturns the instance variable w.shapiro. (numeric)
p.shapiroReturns the instance variable p.shapiro. (numeric)
d.kolmogorowReturns the instance variable d.kolmogorow. (numeric)
p.kolmogorowReturns the instance variable p.kolmogorow. (numeric)
a.andersonReturns the instance variable a.anderson. (numeric)
p.andersonReturns the instance variable p.anderson. (numeric)
Methods
Public methods
Method new()
Creates and returns a new pgu.normDist object.
Usage
pgu.normDist$new(data = "tbl_df")
Arguments
dataThe data to be analyzed. (tibble::tibble)
Returns
A new pgu.normDist object.
(pguIMP::pgu.normDist)
Method finalize()
Clears the heap and
indicates that instance of pgu.normDist is removed from heap.
Usage
pgu.normDist$finalize()
Method print()
Prints instance variables of a pgu.normDist object.
Usage
pgu.normDist$print()
Returns
string
Method resetNormDist()
Resets instance variables
Usage
pgu.normDist$resetNormDist(data = "tbl_df")
Arguments
dataDataframe to be analyzed. (tibble::tibble)
Method resetFail()
Resets instance variables in case of a failed analysis.
Usage
pgu.normDist$resetFail()
Method optimize()
Optimizes the logLikelihood between the data and a normal distribution with respect to the expectation value and standard deviation. The quality of the best model ist calculated subsequently.
Usage
pgu.normDist$optimize()
Method createHistogram()
Creates a histogram from the instance variable rawData.
The histogram is stored in the instance variable histogram.
Usage
pgu.normDist$createHistogram()
Method normalQQData()
Performes a qq-analysis of the instance variable rawData
The qq-analysis is stored in the attributes sample_quantile
and theoretical_quantile of the instance variable rawData.
Usage
pgu.normDist$normalQQData()
Method test.shapiro()
Performes Shapiro-Wilk's test for normality on the
instance variable rawData.
The test result is stored in the instance variable
w.shapiro.
The p-value of the test is stored in the instance variable
p.shapiro
Usage
pgu.normDist$test.shapiro()
Method test.kolmogorow()
Performes Kolmogorow-Smirnow's test for normality on the
instance variable rawData.
The test result is stored in the instance variable
d.kolmogorow.
The p-value of the test is stored in the instance variable
p.kolmogorow
Usage
pgu.normDist$test.kolmogorow()
Method test.anderson()
Performes Anderson-Darling's test for normality on the
instance variable rawData.
The test result is stored in the instance variable
a.anderson.
The p-value of the test is stored in the instance variable
p.anderson
Usage
pgu.normDist$test.anderson()
Method fitResult()
Returns the result of the classes optimize function in form of a formated string.
Usage
pgu.normDist$fitResult()
Returns
String of the results of the fitting routine (character)
Method testResult()
Returns the result of the classes test functions in form of a formated string.
Usage
pgu.normDist$testResult(testName = "Shapiro-Wilk")
Arguments
testNameDefines the test which result shall be returned. Can be of type:
Shapiro-Wilk,Kolmogorow-SmirnoworAnderson-Darling. (character)
Returns
String of the results of the testing routine (character)
Method testResultCompendium()
Returns the result of the classes test functions
Shapiro-Wilk, Kolmogorow-Smirnow and
Anderson-Darling
in form of a formated string.
(character)
Usage
pgu.normDist$testResultCompendium()
Returns
String of the results of the testing routine (character)
Method plotHistogram()
Displays the instance variable histogram
in form of a bar plot and overlays the corresponding normal distribution.
Usage
pgu.normDist$plotHistogram()
Returns
A bar plot. (ggplot2::ggplot)
Method plotResiduals()
Displays the residuals between the instance variable
histogram and the corresponding normal distribution.
Usage
pgu.normDist$plotResiduals()
Returns
A scatter plot. (ggplot2::ggplot)
Method plotResidualDist()
Displays the distribution of the residuals between the distribution of the instance variable
histogram in form of a histogram.
Usage
pgu.normDist$plotResidualDist()
Returns
A bar plot. (ggplot2::ggplot)
Method plotRawResidualDist()
Displays the distribution of the residuals between the distribution of the instance variable
rawData in form of a histogram.
Usage
pgu.normDist$plotRawResidualDist()
Returns
A bar plot. (ggplot2::ggplot)
Method plotRawDataDist()
Displays the distribution of the instance variable
rawData in form of a histogram.
Usage
pgu.normDist$plotRawDataDist()
Returns
A bar plot. (ggplot2::ggplot)
Method normalQQPlot()
Displays a qqplot of the instance variable
rawData.
Usage
pgu.normDist$normalQQPlot()
Returns
A qq-plot. (ggplot2::ggplot)
Method fit()
Runs the optimization process and performs all implemented quality controls. Additionally performs hypothesis tests for nromality.
Usage
pgu.normDist$fit()
Method clone()
The objects of this class are cloneable with this method.
Usage
pgu.normDist$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Author(s)
Sebastian Malkusch, malkusch@med.uni-frankfurt.de
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.