Comprises a list of models for data manipulation.
R6::R6Class object.
modelListReturns a vector of pgu-normDist objects. (pgu.normDist)
modelParameterReturns a dataframe comrising model parameters. (tibble::tibble)
new()Creates and returns a new pgu.model object.
pgu.model$new(data = "tbl_df")
dataThe data to be analyzed. (tibble::tibble)
A new pgu.model object.
(pguIMP::pgu.model)
finalize()Clears the heap and
indicates that instance of pgu.model is removed from heap.
pgu.model$finalize()
print()Prints instance variables of a pgu.model object.
pgu.model$print()
string
resetModelParameter()Resets instance variable modelParameter
pgu.model$resetModelParameter(data = "tbl_df")
dataDataframe to be analyzed. (tibble::tibble)
resetModelList()Resets instance variable modelList
pgu.model$resetModelList(data = "tbl_df")
dataDataframe to be analyzed. (tibble::tibble)
resetModel()Resets instance variable modelList.
Resets instance variable modelParameter.
Displays progress if shiny is loaded.
pgu.model$resetModel(data = "tbl_df", progress = "Progress")
dataDataframe to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
setNormDist()Stores the information of a pgu.norDist object in an
entry of the instance variable modelList
pgu.model$setNormDist(data = "pgu.normDist", feature = "character")
dataInstance of pgu.normDist (pguIMP::pgu.normDist)
featureAttribute corresponding to the pgu.normDist object data. (character)
featureIdx()Returns the index of a pgu.normDist object wihtin the instance variable modelParameter.
pgu.model$featureIdx(feature = "character")
featureAttribute's name. (character)
Index of attribute entry in dataframe (numeric)
fitFeature()Runs the fit function of a pgu.normDist object at a user denied position within the instance variable modelList.
pgu.model$fitFeature(feature = "character")
featureAttribute's name. (character)
fitData()Loops through all attributes and calls the object's ftiFeature function. Displays progress if shiny is loaded.
pgu.model$fitData(progress = "Progress")
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
logFitResultsFeature()Stores results from fitting procedure of a user defined attribute
into the corrsponding attribute of instance variable modelParameter.
pgu.model$logFitResultsFeature(feature = "character")
featureAttribute's name. (character)
logFailedFitResultsFeature()Stores results from fitting procedure of a user defined attribute
into the corrsponding attribute of instance variable modelParameter
in case of a failed fitting routine.
pgu.model$logFailedFitResultsFeature(feature = "character")
featureAttribute's name. (character)
scaleNumeric()Scales numeric data based upon the model of a user defined attribute.
pgu.model$scaleNumeric(value = "numeric", feature = "character")
valueNumeric vector (numeric)
featureAttribute's name. (character)
scaled version of the given vector (numeric)
scaleData()Scales a dataframe based upon a list of models stored in the instance variable modelList..
pgu.model$scaleData(data = "tbl_df")
dataDataframe to be analyzed. (tibble::tibble)
scaled version of the given dataframe (tibble::tibble)
rescaleNumeric()Re-scales numeric data based upon the model of a user defined attribute.
pgu.model$rescaleNumeric(value = "numeric", feature = "character")
valueNumeric vector (numeric)
featureAttribute's name. (character)
Re-scaled version of the given vector (numeric)
rescaleData()Re-scales a dataframe based upon a list of models stored in the instance variable modelList..
pgu.model$rescaleData(data = "tbl_df")
dataDataframe to be analyzed. (tibble::tibble)
Re-scaled version of the given dataframe (tibble::tibble)
modelParameterData()Returns the model parameter (expectation value, standard deviation).
pgu.model$modelParameterData()
Dataframe comprising model parameter. (tibble::tibble)
modelParameterFeature()Returns the model parameter (expectation value, standard deviation) for a user deined attribute.
pgu.model$modelParameterFeature(feature = "character")
featureAttribute's name. (character)
Dataframe comprising model parameter. (tibble::tibble)
modelQualityData()Returns the model parameters connected to model quality.
pgu.model$modelQualityData()
Dataframe comprising model parameter. (tibble::tibble)
modelQualityFeature()Returns the model parameters connected to model quality for a user deined attribute.
pgu.model$modelQualityFeature(feature = "character")
featureAttribute's name. (character)
Dataframe comprising model parameter. (tibble::tibble)
fitResultData()Returns the model fit results.
pgu.model$fitResultData()
Dataframe comprising model fit results. (tibble::tibble)
fitResultFeature()Returns the model fit results for a user deined attribute.
pgu.model$fitResultFeature(feature = "character")
featureAttribute's name. (character)
Dataframe comprising model fit results. (tibble::tibble)
testResultData()Returns the hypothesis test results.
pgu.model$testResultData()
Dataframe comprising the hypothesis test results. (tibble::tibble)
testResultFeature()Returns the hypothesis test results. for a user deined attribute.
pgu.model$testResultFeature(feature = "character")
featureAttribute's name. (character)
Dataframe comprising the hypothesis test results. (tibble::tibble)
plotModel()Creates and returns a composite graphical analysis of the modeling procedure of a user defined attribute.
pgu.model$plotModel(feature = "character")
featureAttribute's name. (character)
Composite result plot. (ggplot2::ggplot)
clone()The objects of this class are cloneable with this method.
pgu.model$clone(deep = FALSE)
deepWhether to make a deep clone.
Comprises a list of pgu.normDist objects and model parameters. These can be used to scale data. This object is used by the shiny based gui and is not for use in individual R-scripts!