| Title: | Visually Guided Preprocessing of Bioanalytical Laboratory Data |
|---|---|
| Description: | Reproducible cleaning of biomedical laboratory data using visualization, error correction, and transformation methods implemented as interactive R notebooks. A detailed description of the methods ca ben found in Malkusch, S., Hahnefeld, L., Gurke, R. and J. Lotsch. (2021) <doi:10.1002/psp4.12704>. |
| Authors: | Sebastian Malkusch [aut] (ORCID: <https://orcid.org/0000-0001-6766-140X>), Jorn Lotsch [aut, cre] (ORCID: <https://orcid.org/0000-0002-5818-6958>) |
| Maintainer: | Jorn Lotsch <[email protected]> |
| License: | GPL (>= 3) |
| Version: | 0.1.1 |
| Built: | 2026-05-22 18:53:59 UTC |
| Source: | https://github.com/jornlotsch/pguimp |
Reproducible cleaning of biomedical laboratory data using visualization, error correction, and transformation methods implemented as interactive R notebooks. A detailed description of the methods ca ben found in Malkusch, S., Hahnefeld, L., Gurke, R. and J. Lotsch. (2021) <doi:10.1002/psp4.12704>.
Sebastian Malkusch [aut] (ORCID: <https://orcid.org/0000-0001-6766-140X>), Jorn Lotsch [aut, cre] (ORCID: <https://orcid.org/0000-0002-5818-6958>)
Maintainer: Jorn Lotsch <[email protected]>
Malkusch S, Hahnefeld L, Gurke R, Lotsch J (2021). "Visually guided preprocessing of bioanalytical laboratory data using an interactive R notebook (pguIMP)." CPT: Pharmacometrics and Systems Pharmacology, 10(11), 1371–1381. doi:10.1002/psp4.12704
# simple examples of the most important functions# simple examples of the most important functions
Returns the central value of a variable.
centralValue(x, ws = NULL)centralValue(x, ws = NULL)
x |
variable |
ws |
weights |
Function that obtains a statistic of centrality of a variable, given a sample of values. If the variable is numeric it returns de median, if it is a factor it returns the mode. In other cases it tries to convert to a factor and then returns the mode. Taken from: https://github.com/ltorgo/DMwR2/
central value
Luis Torgo
centralValue(x = seq(1,10,1))centralValue(x = seq(1,10,1))
Calculates the log Likelihood of a normally distributed event.
dLogLikelihood(x = "numeric", pars = c(mu = 0, sigma = 1))dLogLikelihood(x = "numeric", pars = c(mu = 0, sigma = 1))
x |
The x-value(numeric) |
pars |
Numeric vector with two entries c(mu, sigma). Where mu is the expectation value and sigma is the standard deviation. (numeric) |
The logLikelihood. (numeric)
Sebastian Malkusch
y <- pguIMP::dLogLikelihood(x=5, pars = c(mu=0.0, sigma=1.0))y <- pguIMP::dLogLikelihood(x=5, pars = c(mu=0.0, sigma=1.0))
Imports a data set to the shiny 'pguIMP' web interface. Extracts import options from a 'pguIMP::file' instance and imports the desired record based on the passed information.
importDataSet(obj = "pgu.file")importDataSet(obj = "pgu.file")
obj |
Instance of the R6 class pguIMP::pgu.file. |
A data frame that contains the imported data (tibble::tibble)
Sebastian Malkusch
Imputes missings using kNN.
knnImputation(data, k = 10, scale = TRUE, meth = "weighAvg", distData = NULL)knnImputation(data, k = 10, scale = TRUE, meth = "weighAvg", distData = NULL)
data |
data frame containing missing values |
k |
number of nearest neighbors |
scale |
Indicates if data should be scaled |
meth |
Method for estimating the missing value |
distData |
Distance to the case |
Function that fills in all unknowns using the k Nearest Neighbours of each case with unknows. By default it uses the values of the neighbours and obtains an weighted (by the distance to the case) average of their values to fill in the unknows. If meth='median' it uses the median/most frequent value, instead. Taken from https://github.com/ltorgo/DMwR2/
cleaned data
Luis Torgo
centralValue(x = seq(1,10,1))centralValue(x = seq(1,10,1))
Outlier detection using kth Nearest Neighbour Distance method Takes a dataset and finds its outliers using distance-based method
nnk( x, k = 0.05 * nrow(x), cutoff = 0.95, Method = "euclidean", rnames = FALSE, boottimes = 100 )nnk( x, k = 0.05 * nrow(x), cutoff = 0.95, Method = "euclidean", rnames = FALSE, boottimes = 100 )
x |
dataset for which outliers are to be found |
k |
No. of nearest neighbours to be used, default value is 0.05*nrow(x) |
cutoff |
Percentile threshold used for distance, default value is 0.95 |
Method |
Distance method, default is Euclidean |
rnames |
Logical value indicating whether the dataset has rownames, default value is False |
boottimes |
Number of bootsrap samples to find the cutoff, default is 100 samples |
nnk computes kth nearest neighbour distance of an observation and based on the bootstrapped cutoff, labels an observation as outlier. Outlierliness of the labelled 'Outlier' is also reported and it is the bootstrap estimate of probability of the observation being an outlier. For bivariate data, it also shows the scatterplot of the data with labelled outliers.
Outlier Observations: A matrix of outlier observations
Location of Outlier: Vector of Sr. no. of outliers
Outlier probability: Vector of proportion of times an outlier exceeds local bootstrap cutof
Vinay Tiwari, Akanksha Kashikar
Hautamaki, V., Karkkainen, I., and Franti, P. 2004. Outlier detection using k-nearest neighbour graph. In Proc. IEEE Int. Conf. on Pattern Recognition (ICPR), Cambridge, UK.
#Create dataset X=iris[,1:4] #Outlier detection nnk(X,k=4)#Create dataset X=iris[,1:4] #Outlier detection nnk(X,k=4)
Probability density distribution of a normally distributed variable.
normalDistribution(x = "numeric", mu = "numeric", sigma = "numeric")normalDistribution(x = "numeric", mu = "numeric", sigma = "numeric")
x |
The x-value (numeric) |
mu |
The expextation value (numeric) |
sigma |
The standard deviation (numeric) |
Calculates p(x | mu, sigma). Where p is the probability of observing an event x given the expected value mu and the standard deviation sigma.
The probability of observing event x given mu and sigma. (numeric)
Sebastian Malkusch
y <- pguIMP::normalDistribution(x=5, mu=0.0, sigma=1.0)y <- pguIMP::normalDistribution(x=5, mu=0.0, sigma=1.0)
An R6 class that performs pairwise correlation on the pguIMP data set.
[R6::R6Class] object.
x <- pguIMP::pgu.correlator$new()
featureNamesReturns the instance variable featureNames. (character)
setFeatureNamesSets the instance variable featureNames. It further initializes the instance variables: intercept, pIntercept, slope, pSlope. (character)
methodReturns the instance variable method. (character)
rReturns the instance variable r. (matrix)
pPearsonReturns the instance variable pPearson. (matrix)
tauReturns the instance variable tau. (matrix)
pKendallReturns the instance variable pKendall. (matrix)
rhoReturns the instance variable rho. (matrix)
pSpearmanReturns the instance variable pSpearman. (matrix)
abscissaReturns the instance variable abscissa. (character)
setAbscissaSets the instance variable abscicca to value.
ordinateReturns the instance variable ordinate. (character)
setOrdinateSets the instance variable ordinate to value.
testReturns the instance variable test. (stats::cor.test)
new()
Creates and returns a new 'pgu.correlator' object.
pgu.correlator$new(data = "tbl_df")
dataThe data to be modeled. (tibble::tibble)
A new 'pgu.correlator' object. (pguIMP::pgu.correlator)
finalize()
Clears the heap and indicates if instance of 'pgu.correlator' is removed from heap.
pgu.correlator$finalize()
print()
Prints instance variables of a 'pgu.correlator' object.
pgu.correlator$print()
string
resetCorrelator()
Performes pair-wise correlation analysis on the attributes of the data frame. Progresse is indicated by the progress object passed to the function.
pgu.correlator$resetCorrelator(data = "tbl_df", progress = "Progress")
dataDataframe with at least two numeric attributes. (tibble::tibble)
progressKeeps track of the analysis progress. (shiny::Progress)
resetMatrix()
Creates a square matrix which dimension corresponds to the length of the instance variable featureNames. The matrix entries are set to a distict 'value'.
pgu.correlator$resetMatrix(value = "numeric")
valueThe value the matrix entries are set to. (numeric)
A square matrix. (matrix)
featureIdx()
Determines the numerical index of the column of an attribute based on the attribute name.
pgu.correlator$featureIdx(feature = "character")
featureThe attribute's name. (character)
The attributes column index. (numeric)
calcCorrelationNumeric()
Creates a correlation test between two attributes of a dataframe. The test is stored as instance variable.
pgu.correlator$calcCorrelationNumeric( abscissa = "numeric", ordinate = "numeric", method = "character" )
abscissaThe abscissa values. (numeric)
ordinateThe ordinate values. (numeric)
methodThe cname of the correlation test. Valid coiced are defined by the instance variable 'method'. (chatacter)
createCorrelationMatrixPearson()
Performs the actual correlation test routine after Pearson. Iteratively runs through the attributes known to the class and calculates Pearson's correlation for each valid attribute pair. The test results are stored in the instance variables: r, pPearson. Here, pX represents the p-value of the respective parameter X. Displays the progress if shiny is loaded.
pgu.correlator$createCorrelationMatrixPearson( data = "tbl_df", progress = "Progress" )
dataThe data to be analysed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored within this instance of the shiny Progress class. (shiny::Progress)
createCorrelationMatrixKendall()
Performs the actual correlation test routine after Kendall. Iteratively runs through the attributes known to the class and calculates Kendall's correlation for each valid attribute pair. The test results are stored in the instance variables: tau, pKendall. Here, pX represents the p-value of the respective parameter X. Displays the progress if shiny is loaded.
pgu.correlator$createCorrelationMatrixKendall( data = "tbl_df", progress = "Progress" )
dataThe data to be analysed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored within this instance of the shiny Progress class. (shiny::Progress)
createCorrelationMatrixSpearman()
Performs the actual correlation test routine after Spearman. Iteratively runs through the attributes known to the class and calculates Spearman's correlation for each valid attribute pair. The test results are stored in the instance variables: rho, pSpearman. Here, pX represents the p-value of the respective parameter X. Displays the progress if shiny is loaded.
pgu.correlator$createCorrelationMatrixSpearman( data = "tbl_df", progress = "Progress" )
dataThe data to be analysed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored within this instance of the shiny Progress class. (shiny::Progress)
correlate()
Performs the all three correlation test routines defined within the instance variable 'method'. Displays the progress if shiny is loaded.
pgu.correlator$correlate(data = "tbl_df", progress = "Progress")
dataThe data to be analysed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored within this instance of the shiny Progress class. (shiny::Progress)
printFeature()
Transforms the results of the correlation procedure for a valid pair of attributes to a dataframe and returns it.
pgu.correlator$printFeature()
The analyis result as a dataframe. (tibble::tibble)
printRTbl()
Transfroms instance variable 'r' to a dataframe and returns it.
pgu.correlator$printRTbl()
Dataframe of instance variable 'r'. (tibble::tibble)
printPPearsonTbl()
Transfroms instance variable 'pPearson' to a dataframe and returns it.
pgu.correlator$printPPearsonTbl()
Dataframe of instance variable 'pPearson'. (tibble::tibble)
printTauTbl()
Transfroms instance variable 'tau' to a dataframe and returns it.
pgu.correlator$printTauTbl()
Dataframe of instance variable 'tau'. (tibble::tibble)
printPKendallTbl()
Transfroms instance variable 'pKendall' to a dataframe and returns it.
pgu.correlator$printPKendallTbl()
Dataframe of instance variable 'pKendall'. (tibble::tibble)
printRhoTbl()
Transfroms instance variable 'rho' to a dataframe and returns it.
pgu.correlator$printRhoTbl()
Dataframe of instance variable 'rho'. (tibble::tibble)
printPSpearmanTbl()
Transfroms instance variable 'pSpearman' to a dataframe and returns it.
pgu.correlator$printPSpearmanTbl()
Dataframe of instance variable 'pSpearman'. (tibble::tibble)
clone()
The objects of this class are cloneable with this method.
pgu.correlator$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
require(dplyr) require(tibble) data(iris) data_df <- iris %>% tibble::as_tibble() %>% dplyr::select(-c("Species")) correlator = pguIMP::pgu.correlator$new(data_df)require(dplyr) require(tibble) data(iris) data_df <- iris %>% tibble::as_tibble() %>% dplyr::select(-c("Species")) correlator = pguIMP::pgu.correlator$new(data_df)
An R6 class that performs pairwise correlation of the features of the original and the imputed data set. The correlation results of both data sets are compared by subtraction.
[R6::R6Class] object.
x <- pguIMP::pgu.corrValidator$new()
featureNamesReturns the instance variable featureNames. (character)
orgR_matReturns the instance variable orgR_mat. (matrix)
impR_matReturns the instance variable impR_mat. (matrix)
orgP_matReturns the instance variable orgP_mat. (matrix)
impP_matReturns the instance variable impP_mat. (matrix)
corr_dfReturns the instance variable corr_df. (tibble::tibble)
summary_dfReturns the instance variable summary_df. (tibble::tibble)
new()
Clears the heap and indicates if instance of 'pgu.corrValidator' is removed from heap.
Summary of the correlation deviation distribution.
Creates a square matrix which dimension corresponds to the length of the instance variable featureNames. The matrix entries are set to a distinct 'value'.
Flattens the results transforms them into a dataframe and stores it into the instance variable corr_df.
Creates and returns a new 'pgu.corrValidator' object.
pgu.corrValidator$new(org_df = "tbl_df", imp_df = "tbl_df")
org_dfThe original data to be analyzed. (tibble::tibble)
imp_dfThe imputed version of the org_df data.
A new 'pgu.corrValidator' object. (pguIMP::pgu.corrValidator)
print()
Prints instance variables of a 'pgu.corrValidator' object.
pgu.corrValidator$print()
string
reset()
Resets the object 'pgu.corrValidator' based on the instance variable featureNames..
pgu.corrValidator$reset()
fit()
Runs the corraltion analysis.
pgu.corrValidator$fit(org_df = "tbl_df", imp_df = "tbl_df")
org_dfAdataframe comprising the original data. (tibble::tibble)
imp_dfAdataframe comprising the imputed data. (tibble::tibble)
correlationScatterPlot()
Plots the correlation analysis results.
pgu.corrValidator$correlationScatterPlot()
correlationBarPlot()
Creates and returns a histogram from the cor_delat values.
pgu.corrValidator$correlationBarPlot()
Bar plot (ggplot2::ggplot)
correlationBoxPlot()
Plots the correlation analysis results.
pgu.corrValidator$correlationBoxPlot()
correlationCompoundPlot()
Creates and returns a compund graphical analysis of the cor_delta values.
pgu.corrValidator$correlationCompoundPlot()
Compound plot (gridExtra::grid.arrange)
clone()
The objects of this class are cloneable with this method.
pgu.corrValidator$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
require(dplyr) require(tibble) data(iris) data_df <- iris %>% tibble::as_tibble() comp_df <- data_df %>% dplyr::mutate(Sepal.Length = sample(Sepal.Length)) corr_obj = pguIMP::pgu.corrValidator$new() corr_obj$fit(data_df, comp_df) print(corr_obj)require(dplyr) require(tibble) data(iris) data_df <- iris %>% tibble::as_tibble() comp_df <- data_df %>% dplyr::mutate(Sepal.Length = sample(Sepal.Length)) corr_obj = pguIMP::pgu.corrValidator$new() corr_obj$fit(data_df, comp_df) print(corr_obj)
Handles the pguIMP dataset.
[R6::R6Class] object.
Stores the pguIMP dataset as instance variable and keeps track of the attributes of interest. Provides additionally fast access to several statistical information about the data set. This object is used by the shiny based gui and is not for use in individual R-scripts!
rawDataReturns the instance variable rawData (tibble::tibble)
setRawDataSets the instance variable rawData (tibble::tibble)
attributeNamesReturns the instance variable attributeNames (character)
numericalAttributeNamesReturns the instance variable numericalAttributeNames (character)
categoricalAttributeNamesReturns the instance variable categoricalAttributeNames (character)
classInformationReturns the instance variable classInformation (tibble::tibble)
statisticsReturns the instance variable statistics (tibble::tibble)
reducedStatisticsReturns the instance variable reducedStatistics (tibble::tibble)
missingsStatisticsReturns the instance variable missingsStatistics (tibble::tibble)
new()
Clears the heap and indicates that instance of pguIMP::pgu.data is removed from heap.
Summarizes information on the instance variable rawData and retruns it in form of a compact data frame.
Summarizes a vector of numericals and returns summary.
Iterativley calls the function summarize_numerical_data on all numerical attributes of the instance variable rawData and returns the result in form of a data frame.
Calls the function calculate_statistics filters the result for the attribute names and arithmetic mean values. and returns the result in form of a data frame.
Calls the class' function dataStatistics filters the result for the attribute names and information about missing values. and returns the result in form of a data frame.
Creates and returns a new pguIMP::pgu.data object.
pgu.data$new(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
valVector of numericals to be summarized. (numeric)
A new pguIMP::pgu.data object. (pguIMP::pgu.data)
print()
Prints instance variables of a pguIMP::pgu.data object.
pgu.data$print()
string
fit()
Extracts information about the instance variable rawData.
pgu.data$fit()
attribute_index()
Returns the index of an attribute within the instance variable attributeNames.
pgu.data$attribute_index(attribute = "character")
attributeAttribute's name. (character)
Index of attribute's name in rawData (numeric)
numerical_data()
Returns the numeric attributes of the instance variable rawData.
pgu.data$numerical_data()
A data frame (tibble::tibble)
categorical_data()
Returns the categorical attributes of the instance variable rawData.
pgu.data$categorical_data()
A data frame (tibble::tibble)
clone()
The objects of this class are cloneable with this method.
pgu.data$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
require(dplyr) require(tibble) data(iris) data_df <- iris %>% tibble::as_tibble() data_obj = pguIMP::pgu.data$new(data_df)require(dplyr) require(tibble) data(iris) data_df <- iris %>% tibble::as_tibble() data_obj = pguIMP::pgu.data$new(data_df)
Manages the communication between the shiny gui layer and the classes of the pguIMP package
R6::R6Class object.
Comprises all needed classes from the pguIMP package and manages the communication between the gui and the analysis. This object is used by the shiny based gui and is not for use in individual R-scripts!
statusReturns the instance variable status (pguIMP::pgu.status)
fileNameReturns the instance variable fileName (pguIMP::pgu.file)
loqFileNameReturns the instance variable loqFileName (pguIMP::pgu.file)
rawDataReturns the instance variable rawData (pguIMP::pgu.data)
filterSetReturns the instance variable filterSet (pguIMP::pgu.filter)
filteredDataReturns the instance variable filteredData (pguIMP::pgu.data)
loqReturns the instance variable loq (pguIMP::pgu.limitsOfQuantification)
loqMutatedDataReturns the instance variable loqMutatedData (pguIMP::pgu.data)
explorerReturns the instance variable explorer (pguIMP::pgu.explorer)
optimizerReturns the instance variable optimizer (pguIMP::pgu.optimizer)
transformatorReturns the instance variable transformator (pguIMP::pgu.transformator)
modelReturns the instance variable model (pguIMP::pgu.model)
transformedDataReturns the instance variable transformedData (pguIMP::pgu.data)
featureModelReturns the instance variable featureModel (pguIMP::pgu.normDist)
normalizerReturns the instance variable normalizer (pguIMP::pgu.normalizer)
normalizedDataReturns the instance variable normalizedData (pguIMP::pgu.data)
missingsReturns the instance variable missings (pguIMP::pgu.missings)
missingsCharacterizerReturns the instance variable missingsCharacterizer (pguIMP::pgu.missingsCharacterizer)
outliersReturns the instance variable outlierd (pguIMP::pgu.outliers)
imputerReturns the instance variable imputer (pguIMP::pgu.imputation)
imputedDataReturns the instance variable imputedData (pguIMP::pgu.data)
cleanedDataReturns the instance variable cleanedData (pguIMP::pgu.data)
validatorReturns the instance variable validator (pguIMP::pgu.validator)
corrValidatorReturns the instance variable corrValidator (pguIMP::pgu.corrValidator)
exporterReturns the instance variable exporter (pguIMP::pgu.exporter)
reporterReturns the instance variable reporter (pguIMP::pgu.reporter)
new()
Clears the heap and
indicates that instance of pgu.delegate is removed from heap.
Creates and returns a new pgu.delegate object.
pgu.delegate$new(data = "tbl_df")
dataThe data to be analyzed. (tibble::tibble)
A new pgu.delegate object.
(pguIMP::pgu.delegate)
print()
Prints instance variables of a pgu.delegate object.
pgu.delegate$print()
string
update_import_gui()
Updates the import gui
pgu.delegate$update_import_gui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
query_data()
Manages the data upload to the R server. Updates the instance class status.
pgu.delegate$query_data(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
import_data()
Imports uploaded data from the R server into the instance variable rawData. Updates the instance class status.
pgu.delegate$import_data(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_import_data_Types_tbl()
Updates the tbl.importDataTypes table.
pgu.delegate$update_import_data_Types_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_import_data_statistics_tbl()
Updates the tbl.importDataStatistics table.
pgu.delegate$update_import_data_statistics_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_import_missings_statistics_tbl()
Updates the tbl.importMissingsStatistics table.
pgu.delegate$update_import_missings_statistics_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_filter_select_tbl()
Updates the tbl.filter table.
pgu.delegate$update_filter_select_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_filter()
Queries the filter parameters selected by the user in the gui and stores them in the instance variable filterSet.
pgu.delegate$update_filter(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_filter_inverse()
Queries the filter parameters selected by the user in the gui inverts them and stores them in the instance variable filterSet.
pgu.delegate$update_filter_inverse(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
reset_filter()
Generates a filter set that selects the whole data frame. Stores them in the instance variable filterSet. Updates the gui.
pgu.delegate$reset_filter(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
filter_data()
Filters the data corresponding to the user defined parameters stored in the instance variable filterSet. Results are stored in the instance variables filteredData and filteredMetadata. Updated the instance variable filterSet.
pgu.delegate$filter_data(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_filter_statistics_tbl()
Updates the tbl.filterStatistics table.
pgu.delegate$update_filter_statistics_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_filter_missings_tbl()
Updates the tbl.filterMissings table.
pgu.delegate$update_filter_missings_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_exploration_gui()
Updates the gui.
pgu.delegate$update_exploration_gui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_exploration_abscissa()
Transfers the information oabout the selected abscissa attribute to the explorer class.
pgu.delegate$update_exploration_abscissa(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_exploration_ordinate()
Transfers the information oabout the selected ordinate attribute to the explorer class.
pgu.delegate$update_exploration_ordinate(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_exploration_graphic()
Updates the exploration abscissa vs. ordinate scatter plot corresponding to the respective user defined attributes.
pgu.delegate$update_exploration_graphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_exploration_abscissa_graphic()
Updates the abscissa compound plot corresponding to the respective user defined attributes.
pgu.delegate$update_exploration_abscissa_graphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_exploration_ordinate_graphic()
Updates the ordinate compound plot corresponding to the respective user defined attributes.
pgu.delegate$update_exploration_ordinate_graphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_exploration_abscissa_table()
Updates the numerical abscissa analysis table. corresponding to the respective user defined attributes.
pgu.delegate$update_exploration_abscissa_table(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_exploration_ordinate_table()
Updates the numerical ordinate analysis table. corresponding to the respective user defined attributes.
pgu.delegate$update_exploration_ordinate_table(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
reset_loq_values()
Initializes the LOQ object after filtering.
pgu.delegate$reset_loq_values(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_upload_gui()
Updates the gui.
pgu.delegate$update_loq_upload_gui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
query_loq()
Manages the loq data upload to the R server.
pgu.delegate$query_loq(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
import_loq()
Imports the loq data upload to the R server.
pgu.delegate$import_loq(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_define_gui()
Updates the gui.
pgu.delegate$update_loq_define_gui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_define_feature()
Updates the gui.
pgu.delegate$update_loq_define_feature(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_define_lloq()
Updates the gui.
pgu.delegate$update_loq_define_lloq(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_define_uloq()
Updates the gui.
pgu.delegate$update_loq_define_uloq(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_define_table()
Updates the gui.
pgu.delegate$update_loq_define_table(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_define_menu()
Updates the gui.
pgu.delegate$update_loq_define_menu(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
set_loq_define_values()
Updates loq class.
pgu.delegate$set_loq_define_values(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
set_loq_define_values_globally()
Updates loq class.
pgu.delegate$set_loq_define_values_globally(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
Imports uploaded data from the R server into the instance variable loqData. Updates the instance class status.
Example code:
importLoq = function(input, output, session){
if (private$.status$query(processName = "dataImported")){
tryCatch({
private$.loq$setLoq <- private$.importer$importLoq(self$fileName)
private$.status$update(processName = "loqImported", value = TRUE)
},
error = function(e) {
private$.status$update(processName = "loqImported", value = FALSE)
shiny::showNotification(paste(e),type = "error", duration = 10)
}#error
)#tryCatch
}#if
else{
private$.status$update(processName = "loqImported", value = FALSE)
shiny::showNotification(paste("No file uploaded to import. Please upload a valid file first."),type = "error", duration = 10)
}#else
}, #function
update_loq_detect_gui()
Updates the gui.
pgu.delegate$update_loq_detect_gui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_na_handling()
Updates the si.loqHandling shiny widget corresponding to the respective user defined parameter.
pgu.delegate$update_loq_na_handling(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
init_detect_loq()
Runs the outlier detection routine of the instance variable outliers. Updates the instance class status.
pgu.delegate$init_detect_loq(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
detect_loq()
Runs the outlier detection routine of the instance variable outliers. Updates the instance class status.
pgu.delegate$detect_loq(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_detect_statistics_tbl()
Updates the numerical loq statistics analysis table
pgu.delegate$update_loq_detect_statistics_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_detect_outlier_tbl()
Updates the numerical loq table.
pgu.delegate$update_loq_detect_outlier_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_detect_statistics_graphic()
Updates the loq statistics graphic.
pgu.delegate$update_loq_detect_statistics_graphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_detect_attribute_graphic()
Updates the loq feature compound graphic.
pgu.delegate$update_loq_detect_attribute_graphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_detect_attribute_tbl()
Updates the numerical loq feature table.
pgu.delegate$update_loq_detect_attribute_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_mutate_gui()
Updates the gui.
pgu.delegate$update_loq_mutate_gui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_lloq_substitute()
Updates the si.lloqSubstitute shiny widget.
pgu.delegate$update_lloq_substitute(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_uloq_substitute()
Updates the si.uloqSubstitute shiny widget.
pgu.delegate$update_uloq_substitute(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
init_mutate_loq()
Calls the mutation routine of the instance variable loq on the instance variable filteredData. The reult is stored in the instance variable loqMutatedData Updates the instance class status.
pgu.delegate$init_mutate_loq(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
mutate_loq()
Calls the mutation routine of the instance variable loq on the instance variable filteredData. The reult is stored in the instance variable loqMutatedData Updates the instance class status.
pgu.delegate$mutate_loq(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_mutate_data_tbl()
Updates the numerical loq mutate outliers table.
pgu.delegate$update_loq_mutate_data_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_mutate_statistics_graphic()
Updates the loq mutate statistics graphic.
pgu.delegate$update_loq_mutate_statistics_graphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_mutate_attribute_graphic()
Updates the loq mutate feature graphic.
pgu.delegate$update_loq_mutate_attribute_graphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
init_loq_mutate_attribute_tbl()
Updates the numeric loq mutate feature table.
pgu.delegate$init_loq_mutate_attribute_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_loq_mutate_attribute_tbl()
Updates the numeric loq mutate feature table.
pgu.delegate$update_loq_mutate_attribute_tbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
optimizeTrafoParameter()
Calls the optimize routine of the instance variable optimizer on the instance variable loqMutatedData. Updates the instance class status.
pgu.delegate$optimizeTrafoParameter(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateDetectedTrafoTypes()
Updates the detected trafo types table.
pgu.delegate$updateDetectedTrafoTypes(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateDetectedTrafoParameter()
Updates the detected trafo parameters table.
pgu.delegate$updateDetectedTrafoParameter(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoDetectGui()
Updates the gui.
pgu.delegate$updateTrafoDetectGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateFeature()
Updates the si.trafoMutateFeature shiny widget.
pgu.delegate$updateTrafoMutateFeature(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateType()
Updates the si.trafoMutateType shiny widget.
pgu.delegate$updateTrafoMutateType(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateLambda()
Updates the ni.trafoMutateLambda shiny widget.
pgu.delegate$updateTrafoMutateLambda(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateMirror()
Updates the cb.trafoMutateMirror shiny widget.
pgu.delegate$updateTrafoMutateMirror(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
resetTrafoMutateGui()
Updates the gui.
pgu.delegate$resetTrafoMutateGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateGui()
Updates the gui.
pgu.delegate$updateTrafoMutateGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
trafoMutateFit()
Estimates the optimal transformation parameters. Updates the GUI
pgu.delegate$trafoMutateFit(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
trafoMutateGlobal()
Calls the transformation routine of the instance variable transformator on the instance variable loqMutatedData. Updates the instance class status.
pgu.delegate$trafoMutateGlobal(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
trafoMutateFeature()
Calls the transformation routine of the instance variable transformator on a user defined attribute of the instance variable loqMutatedData.
pgu.delegate$trafoMutateFeature(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateFeatureGraphic()
Updates the trafo mutate feature graphic.
pgu.delegate$updateTrafoMutateFeatureGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateFeatureParameterTbl()
Updates the trafo mutate feature patameter table.
pgu.delegate$updateTrafoMutateFeatureParameterTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateFeatureQualityTbl()
Updates the trafo mutate feature quality table.
pgu.delegate$updateTrafoMutateFeatureQualityTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateGlobalParameterTbl()
Updates the trafo mutate global parameter table.
pgu.delegate$updateTrafoMutateGlobalParameterTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateGlobalModelTbl()
Updates the tbl.trafoMutateGlobalModel table.
pgu.delegate$updateTrafoMutateGlobalModelTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateGlobalQualityTbl()
Updates the tbl.trafoMutateGlobalQuality table.
pgu.delegate$updateTrafoMutateGlobalQualityTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateGlobalTestsTbl()
Updates the tbl.trafoMutateGlobalTests table.
pgu.delegate$updateTrafoMutateGlobalTestsTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoMutateGlobalDataTbl()
Updates the tbl.trafoMutateGlobalData table.
pgu.delegate$updateTrafoMutateGlobalDataTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoNormFeature()
Updates the si.trafoNormFeature shiny widget.
pgu.delegate$updateTrafoNormFeature(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoNormMethod()
Updates the si.trafoNormMethod shiny widget.
pgu.delegate$updateTrafoNormMethod(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoNormGui()
Updates the gui.
pgu.delegate$updateTrafoNormGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
trafoNormMutate()
Calls the scale routine of the instance variable normalizer on the instance variable transformedData. Updates the instance class status.
pgu.delegate$trafoNormMutate(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoNormFeatureGraphic()
Updates the impute norm feature compound graphic.
pgu.delegate$updateTrafoNormFeatureGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
resetTrafoNormGui()
Updates the gui.
pgu.delegate$resetTrafoNormGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoNormFeatureStatisticsTbl()
Updates the numerical impute norm analysis table for a user defined feature. corresponding to the respective user defined attributes.
pgu.delegate$updateTrafoNormFeatureStatisticsTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoNormStatisticsTbl()
Updates the numerical impute norm analysis table. corresponding to the respective user defined attributes.
pgu.delegate$updateTrafoNormStatisticsTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoNormParameterTbl()
Updates the impute norm parameter table. corresponding to the respective user defined attributes.
pgu.delegate$updateTrafoNormParameterTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateTrafoNormDataTbl()
Updates the impute norm scaled data table. corresponding to the respective user defined attributes.
pgu.delegate$updateTrafoNormDataTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
imputeMissingsAnalyze()
Calls the missing detection routine of the instance variable imputer on the instance variable normalizedData. Updates the instance class status.
pgu.delegate$imputeMissingsAnalyze(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMissingsGraphic()
Updates the plt.imputeMissingsSummary graphic.
pgu.delegate$updateImputeMissingsGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMissingsStatisticsTbl()
Updates the tbl.imputeMissingsStatistics table.
pgu.delegate$updateImputeMissingsStatisticsTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMissingsDistributionTbl()
Updates the tbl.imputeMissingsDistribution table.
pgu.delegate$updateImputeMissingsDistributionTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMissingCharacteristicsGraphic()
Updates the plt.imputeMissingsPairs graphic.
pgu.delegate$updateImputeMissingCharacteristicsGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMissingsCharacteristicsTbl()
Updates the tbl.imputeMissingsCharacteristics table.
pgu.delegate$updateImputeMissingsCharacteristicsTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMissingsDetailTbl()
Updates the tbl.imputeDetectDetail table.
pgu.delegate$updateImputeMissingsDetailTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMissingsDataTbl = function(input, output, session){
if(self$status$query(processName = "naDetected")){
output$tbl.imputeMissingsData <- DT::renderDataTable(
self$filteredMetadata$rawData %>%
dplyr::right_join(self$normalizedData$rawData, by = "Sample Name") %>%
format.data.frame(scientific = TRUE, digits = 4) %>%
DT::datatable(
extensions = "Buttons",
options = list(
scrollX = TRUE,
scrollY = '350px',
paging = FALSE,
dom = "Blfrtip",
buttons = list(list(
extend = 'csv',
filename = self$fileName$predict("imputationSiteDetectionData") %>%
tools::file_path_sans_ext(),
text = "Download"
))#buttons
)#options
)#DT::datatable
)#output
}#if
else{
output$tbl.imputeMissingsData <- DT::renderDataTable(NULL)
}#else
}, #function
updateImputeOutliersMethod()
Updates the si.imputeOutliersMethod shiny widget.
pgu.delegate$updateImputeOutliersMethod(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersFeature()
Updates the si.imputeOutliersFeature shiny widget.
pgu.delegate$updateImputeOutliersFeature(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersAlpha()
Updates the ni.imputeOutliersAlpha shiny widget.
pgu.delegate$updateImputeOutliersAlpha(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersEpsilon()
Updates the ni.imputeOutliersEpsilon shiny widget.
pgu.delegate$updateImputeOutliersEpsilon(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersMinSamples()
Updates the ni.imputeOutliersMinSamples shiny widget.
pgu.delegate$updateImputeOutliersMinSamples(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersGamma()
Updates the ni.imputeOutliersGamma shiny widget.
pgu.delegate$updateImputeOutliersGamma(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersNu()
Updates the ni.imputeOutliersNu shiny widget.
pgu.delegate$updateImputeOutliersNu(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersCutoff()
Updates the ni.imputeOutliersCutoff shiny widget.
pgu.delegate$updateImputeOutliersCutoff(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersK()
Updates the ni.imputeOutliersK shiny widget.
pgu.delegate$updateImputeOutliersK(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersSeed()
Updates the ni.imputeOutliersSeed shiny widget.
pgu.delegate$updateImputeOutliersSeed(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersGui()
Updates the gui.
pgu.delegate$updateImputeOutliersGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
resetImputeOutliersGui()
Updates the gui.
pgu.delegate$resetImputeOutliersGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
imputeOutliersDetect()
Calls the detectOutliers routine of the instance variable outliers on the instance variable normalizedData. Updates the instance class status.
pgu.delegate$imputeOutliersDetect(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersGraphic()
Updates the plt.outliersImputeSummary graphic.
pgu.delegate$updateImputeOutliersGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersFeatureGraphic()
Updates the plt.outliersImputeFeature graphic.
pgu.delegate$updateImputeOutliersFeatureGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersFeatureTbl()
Updates the numeric outlier feature table.
pgu.delegate$updateImputeOutliersFeatureTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersStatisticsTbl()
Updates the numerical loq statistics analysis table
pgu.delegate$updateImputeOutliersStatisticsTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeOutliersDetailTbl()
Updates the numerical outlier table.
pgu.delegate$updateImputeOutliersDetailTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateFeature()
Updates the si.imputeMutateFeature shiny widget.
pgu.delegate$updateImputeMutateFeature(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateMethod()
Updates the si.imputeMutateMethod shiny widget.
pgu.delegate$updateImputeMutateMethod(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateNNeighbors()
Updates the ni.imputeMutateNumberOfNeighbors shiny widget.
pgu.delegate$updateImputeMutateNNeighbors(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutatePredFrac()
Updates the ni.imputeMutatePredFrac shiny widget.
pgu.delegate$updateImputeMutatePredFrac(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateOutfluxThr()
Updates the ni.imputeMutateOutfluxThr shiny widget.
pgu.delegate$updateImputeMutateOutfluxThr(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateSeed()
Updates the ni.imputeMutateSeed shiny widget.
pgu.delegate$updateImputeMutateSeed(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateIterations()
Updates the ni.imputeMutateIterations shiny widget.
pgu.delegate$updateImputeMutateIterations(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateGui()
Updates the gui.
pgu.delegate$updateImputeMutateGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
resetImputeMutateGui()
Resets the gui.
pgu.delegate$resetImputeMutateGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
imputeMutateMutate()
Calls the mutate imputation site routine of the instance variable imputer on the instance variable transformedData. Updates the instance class status.
pgu.delegate$imputeMutateMutate(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeFluxGraphic()
Updates the plt.imputeMutateFlux graphic.
pgu.delegate$updateImputeFluxGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateGraphic()
Updates the plt.imputeMutateSummary graphic.
pgu.delegate$updateImputeMutateGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateStatisticsTbl()
Updates the tbl.imputeMutateStatistics table.
pgu.delegate$updateImputeMutateStatisticsTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateDistributionTbl()
Updates the tbl.imputeMutateDistribution table.
pgu.delegate$updateImputeMutateDistributionTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateFeatureDetailGraphic()
Updates the plt.imputeMutateFeatureDetail graphic.
pgu.delegate$updateImputeMutateFeatureDetailGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateFeatureDetailTbl()
Updates the tbl.imputeMutateFeatureDetail table.
pgu.delegate$updateImputeMutateFeatureDetailTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateDetailTbl()
Updates the tbl.imputeMutateDetail table.
pgu.delegate$updateImputeMutateDetailTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateImputeMutateDataTbl()
Updates the tbl.imputeMutateData table.
pgu.delegate$updateImputeMutateDataTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
validate()
Calls the validate routine of the instance variable validator on the instance variables rawData and clenaedData. Updates the instance class status.
pgu.delegate$validate(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateAnalysisValidationGui()
Updates the si.analysisValidationFeature shiny widget.
pgu.delegate$updateAnalysisValidationGui(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateAnalysisValidationGraphic()
Updates the plt.analysisValidationFeature shiny widget.
pgu.delegate$updateAnalysisValidationGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateAnalysisValidationTestTbl()
Updtates the tbl.analysisValidationTest table.
pgu.delegate$updateAnalysisValidationTestTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateCentralMomentsOrgTbl()
Updtates the tbl.centralMomentsOrg table.
pgu.delegate$updateCentralMomentsOrgTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateCentralMomentsImpTbl()
Updtates the tbl.centralMomentsImp table.
pgu.delegate$updateCentralMomentsImpTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateCentralMomentsDeltaTbl()
Updtates the tbl.centralMomentsDelta table.
pgu.delegate$updateCentralMomentsDeltaTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateCorrelationValidationScatterGraphic()
Updtates the plt.correlationValidationScatter graphic.
pgu.delegate$updateCorrelationValidationScatterGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateCorrelationValidationBoxPlotGraphic()
Updtates the plt.correlationValidationBoxPlot graphic.
pgu.delegate$updateCorrelationValidationBoxPlotGraphic(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateCorrelationValidationDeviationTbl()
Updtates the tbl.correlationValidationDeviation table.
pgu.delegate$updateCorrelationValidationDeviationTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
updateCorrelationValidationDataTbl()
Updtates the tbl.correlationValidationData table.
pgu.delegate$updateCorrelationValidationDataTbl(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
exportFileName()
Creates and returns an export filename.
pgu.delegate$exportFileName(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
export filename (character)
exportData()
Exports the pguIMP analysis results
pgu.delegate$exportData(input, file)
inputPointer to shiny input
fileexport filename (character)
reportFileName()
Creates and returns a report filename.
pgu.delegate$reportFileName(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
export filename (character)
writeReport()
Exports a report on the pguIMP analysis in pdf format.
pgu.delegate$writeReport(input, file)
inputPointer to shiny input
fileexport filename (character)
hide_outdated_results()
Updates the gui if analysis parameters change.
pgu.delegate$hide_outdated_results(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
update_help_html()
Updates the gui if analysis parameters change.
pgu.delegate$update_help_html(input, output, session)
inputPointer to shiny input
outputPointer to shiny output
sessionPointer to shiny session
clone()
The objects of this class are cloneable with this method.
pgu.delegate$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Visual exploration of the pguIMP dataset.
[R6::R6Class] object.
Pariwise anlysis of attributes from the pguIMP dataset. This object is used by the shiny based gui and is not for use in individual R-scripts!
rawDataReturns the instance variable rawData (tibble::tibble)
setRawDataSets the instance variable rawData (tibble::tibble)
abscissaReturns the instance variable abscissa (character)
setAbscissaSets the instance variable abscissa (character)
ordinateReturns the instance variable ordinate (character)
setOrdinateSets the instance variable ordinate (character)
abscissaStatisticsReturns the instance variable abscissaStatistics (character)
ordinateStatisticsReturns the instance variable ordinateStatistics (character)
new()
Tests if the abscissa attribute is of type numeric.
Tests if the ordinate attribute is of type numeric.
Summarizes the numeric values of a vector.
Calculates the statistics of the abscissa values. Stores the result in the instance variable abscissaStatistics.
Calculates the statistics of the ordinate values. Stores the result in the instance variable ordinateStatistics.
Clears the heap and indicates that instance of 'pgu.explorer' is removed from heap.
Creates and returns a new 'pgu.explorer' object.
pgu.explorer$new(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
A new 'pgu.explorer' object. (pguIMP::pgu.optimizer)
print()
Prints instance variables of a 'pgu.explorer' object.
pgu.explorer$print()
string
reset()
Resets the instance of the pgu.explorer class
pgu.explorer$reset(data_df = "tbl_df", abs = "character", ord = "character")
data_dfThe data to be analyzed. (tibble::tibble)
absThe abscissa attribute (character)
ordThe ordinate attribute (character)
fit()
Calculates the abscissa and ordinate statistics
pgu.explorer$fit()
scatterPlot()
Creates and returns a scatter plot abscissa and ordinate value pairs.
pgu.explorer$scatterPlot()
Scatter plot (ggplot2::ggplot)
abscissaBarPlot()
Creates and returns a histogram from the abscissa values.
pgu.explorer$abscissaBarPlot()
Bar plot (ggplot2::ggplot)
abscissaBoxPlot()
Creates and returns a box plot from the abscissa values.
pgu.explorer$abscissaBoxPlot()
Box plot (ggplot2::ggplot)
abscissaPlot()
Creates and returns a compund graphical analysis of the abscissa values.
pgu.explorer$abscissaPlot()
Compound plot (gridExtra::grid.arrange)
ordinateBarPlot()
Creates and returns a histogram from the ordinate values.
pgu.explorer$ordinateBarPlot()
Bar plot (ggplot2::ggplot)
ordinateBoxPlot()
Creates and returns a box plot from the ordinate values.
pgu.explorer$ordinateBoxPlot()
Box plot (ggplot2::ggplot)
ordinatePlot()
Creates and returns a compund graphical analysis of the ordinate values.
pgu.explorer$ordinatePlot()
Compound plot (gridExtra::grid.arrange)
clone()
The objects of this class are cloneable with this method.
pgu.explorer$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
A class that writes the results of the pguIMP analysis to an Excel file.
[R6::R6Class] object.
Creates a download file name and saves a list of tibbles to an Excel file. Each tibble is written to a separate sheet. This object is used by the shiny based gui and is not for use in individual R-scripts!
fileNameReturns the fileName. (character)
setFileNameSet the fileName. (character)
suffixReturns the file suffix. (character)
new()
Creates and returns a new 'pgu.exporter' object.
pgu.exporter$new()
A new 'pgu.exporter' object. (pguIMP::pgu.exporter)
finalize()
Clears the heap and indicates if instance of 'pgu.exporter' is removed from heap.
pgu.exporter$finalize()
print()
Prints instance variables of a 'pgu.exporter' object.
pgu.exporter$print()
string
extractSuffix()
extracts the suffix from the fileName
pgu.exporter$extractSuffix()
writeDataToExcel()
writes tibble to an excel file of the name fileName.
pgu.exporter$writeDataToExcel(obj = "list")
objA tibble or list of tibble. If obj is a list, each member will be written to a seperate sheet.
clone()
The objects of this class are cloneable with this method.
pgu.exporter$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Handles file names for the pguIMP shiny web interface.
[R6::R6Class] object.
The class stores filenames and upload specifications for the pguIMP shiny web interface in its instance variables. This object is used by the shiny based gui and is not for use in individual R-scripts!
uploadFileNameReturns the instance variable uploadFileName (character)
fileNameReturns the instance variable fileName (character)
baseNameReturns the instance variable baseName (character)
folderNameReturns the instance variable folderName (character)
suffixReturns the instance variable suffix (character)
exportSuffixReturns the instance variable exportSuffix (character)
timeStringReturns the instance variable timeString (character)
sheetIndexReturns the instance variable sheetIndex (numeric)
separatorReturns the instance variable separator (character)
skipRowsReturns the instance variable skipRows (numeric)
columnNamesReturns the instance variable columnNames (logical)
naCharReturns the instance variable naChar (character)
new()
Clears the heap and indicates that instance of 'pgu.file' is removed from heap.
Splits fileName and writes the results in the class' instance variables folderName, baseName, suffix.
Stores the current system time into the instance variable timeString.
Creates and returns a new object of type pgu.file.
pgu.file$new( uploadFileName = "", fileName = "", sheetIndex = 1, separator = ",", skipRows = 0, columnNames = TRUE, naChar = "NA" )
uploadFileNameName of uploaded file. (string)
fileNameActual file name. (string)
sheetIndexIndex excel sheet to import. (integer)
separatorCharacter for column separation. (character)
skipRowsNumber of rows to skip. (integer)
columnNamesIndicates if the data source file has a columnNames. (logical)
naCharCharacter for missing values. (string)
A new pgu.file object. (pguIMP::pgu.file)
print()
Prints the instance variables of the object.
pgu.file$print()
string
reset()
Resets the instance variables of the object.
pgu.file$reset( uploadFileName = "", fileName = "", sheetIndex = 1, separator = ",", skipRows = 0, columnNames = TRUE, naChar = "NA" )
uploadFileNameName of uploaded file. (string)
fileNameActual file name. (string)
sheetIndexIndex excel sheet to import. (integer)
separatorCharacter for column separation. (character)
skipRowsNumber of rows to skip. (integer)
columnNamesIndicates if the data source file has a columnNames. (logical)
naCharCharacter for missing values. (string)
fit()
Extracts information about upload specifications from the instance variables.
pgu.file$fit()
predict()
Predicts an export file name.
pgu.file$predict(affix = "analysis")
affixUser dedined file name affix. (string)
A file name. (string)
fit_predict()
Extracts information about upload specifications from the instance variables and predicts an export file name.
pgu.file$fit_predict(affix = "analysis")
affixUser dedined file name affix. (string)
A file name. (string)
clone()
The objects of this class are cloneable with this method.
pgu.file$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Filter the pguIMP dataset.
[R6::R6Class] object.
The filtering is done by column and row indices. This object is used by the shiny based gui and is not for use in individual R-scripts!
colIdxReturns the instance variable colIdx (numeric)
setColIdxSets the instance variable colIdx (numeric)
rowIdxReturns the instance variable rowIdx (numeric)
setRowIdxSets the instance variable rowIdx (numeric)
new()
Resets the filter parameter colIdx to the full dataframe.
Resets the filter parameter rowIdx to the full dataframe.
Clears the heap and indicates that instance of pguIMP::pgu.filter is removed from heap.
Creates and returns a new pguIMP::pgu.filter object.
pgu.filter$new(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
A new pguIMP::pgu.filter object. (pguIMP::pgu.filter)
print()
Prints instance variables of a pguIMP::pgu.filter object.
pgu.filter$print()
string
reset()
Resets the filter parameter colIdx and rowIdx to the full dataframe.
pgu.filter$reset(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
predict()
Filters and returns the given data frame.
pgu.filter$predict(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
The filtered data frame (tibble::tibble)
clone()
The objects of this class are cloneable with this method.
pgu.filter$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Handles the data import
[R6::R6Class] object.
Menages the import of the pguIMP dataset This object is used by the shiny based gui and is not for use in individual R-scripts!
suffixesReturns the instance variable suffixes (character)
new()
Creates and returns a new 'pgu.importer' object.
pgu.importer$new()
A new 'pgu.importer' object. (pguIMP::pgu.importer)
finalize()
Clears the heap and indicates that instance of 'pgu.importer' is removed from heap.
pgu.importer$finalize()
print()
Prints instance variables of a 'pgu.importer' object.
pgu.importer$print()
string
suffixIsKnown()
Takes an instance of pgu.file and tests if the suffix is valid.
pgu.importer$suffixIsKnown(obj = "pgu.file")
objinstance of pgu.file. (pguIMP::pgu.file)
test result (logical)
importData()
Takes an instance of pgu.file imports a dataset.
pgu.importer$importData(obj = "pgu.file")
objinstance of pgu.file. (pguIMP::pgu.file)
data frame (tibble::tibble)
importLoq()
Takes an instance of pgu.file imports a loq dataset.
pgu.importer$importLoq(obj = "pgu.file")
objinstance of pgu.file. (pguIMP::pgu.file)
data frame (tibble::tibble)
importMetadata()
Takes an instance of pgu.file imports a metadata dataset.
pgu.importer$importMetadata(obj = "pgu.file")
objinstance of pgu.file. (pguIMP::pgu.file)
data frame (tibble::tibble)
clone()
The objects of this class are cloneable with this method.
pgu.importer$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Analyses and substitutes imputation sites in a data set.
[R6::R6Class] object.
Analyses imputation sites in a data set. Replaces imputation sites by missing values and substitutes NAs by classical and ML-powered substitution algorithms. This object is used by the shiny based gui and is not for use in individual R-scripts!
imputationStatisticsReturns the instance variable imputationStatistics. (tibble::tibble)
imputationSitesReturns the instance variable imputationSites. (tibble::tibble)
one_hot_dfReturns the positions of missings in one_hot encoding (tibble::tibble)
imputationSiteDistributionReturns the instance variable imputationSiteDistribution. (matrix)
imputationAgentAlphabetReturns the instance variable imputationagentAlphabet. (character)
imputationAgentReturns the instance variable imputationAgent. (character)
setImputationAgentSets the instance variable imputationAgent. (character)
nNeighborsReturns the instance variable nNeighbors. (integer)
setNNeighborsSets the instance variable nNeighbors. (integer)
flux_dfReturns the instance variable flux_df (tibble::tibble)
outflux_thrReturns the instance variable outflux_thr. (numeric)
setOutflux_thrSets the instance variable outflux_thr. (numeric)
pred_fracReturns the instance variable pred_frac. (numeric)
setPred_fracSets the instance variable pred_frac. (numeric)
pred_matReturns the instance variable pred_mat. (matrix)
exclude_vecReturns the instance variable exclude_vec (character)
seedReturns the instance variable seed. (numeric)
setSeedSets the instance variable seed. (numeric)
iterationsReturns the instance variable iterations. (numeric)
setIterationsSets the instance variable iterations. (numeric)
amvReturns the instance variable amv. (numeric)
successReturns the instance variable success. (logical)
new()
Creates and returns a new 'pgu.imputation' object.
pgu.imputation$new( seed = 42, iterations = 4, imputationAgent = "none", nNeighbors = 3, pred_frac = 1, outflux_thr = 0.5 )
seedInitially sets the instance variable seed. Default is 42. (integer)
iterationsInitially sets the instance variable iterations. Default is 4. (integer)
imputationAgentInitially sets the instance variable imputationAgent. Default is "none". Options are: ""none", "median", "mean", "expValue", "monteCarlo", "knn", "pmm", "cart", "randomForest", "M5P". (string)
nNeighborsInitially sets the instance variable nNeighbors. (integer)
pred_fracInitially sets the instance variable pred_frac. (numeric)
outflux_thrInitially sets the instance variable outflux_thr
A new 'pgu.imputation' object. (pguIMP::pgu.imputation)
finalize()
Clears the heap and indicates that instance of 'pgu.imputation' is removed from heap.
pgu.imputation$finalize()
print()
Prints instance variables of a 'pgu.imputation' object.
pgu.imputation$print()
string
gatherImputationSites()
Gathers imputation sites from pguIMP's missings and outliers class.
pgu.imputation$gatherImputationSites( missings_df = "tbl_df", outliers_df = "tbl_df" )
missings_dfDataframe comprising information about the imputation sites of pguIMP's missings class. (tibble::tibble)
outliers_dfDataframe comprising information about the imputation sites of pguIMP's outliers class. (tibble::tibble)
gatherImputationSiteStatistics()
Gathers statistical information about imputation sites The information is stored within the classes instance variable 'imputationStatistics'
pgu.imputation$gatherImputationSiteStatistics(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
gatherImputationSiteDistribution()
Gathers the distribution of imputation sites within the data frame. The information is stored within the classes instance variable imputationSiteDistribution.
pgu.imputation$gatherImputationSiteDistribution(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
A data frame (tibble::tibble)
insertImputationSites()
Takes a dataframe, replaces the imputation sites indicated by the instance variable 'imputationsites' by NA, and returns the mutated dataframe.
pgu.imputation$insertImputationSites(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
A mutated version of data_df. (tibble::tibble)
one_hot()
Gathers statistical information about missing values in one hot format. The result is stored in the instance variable one_hot_df.
pgu.imputation$one_hot(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
analyzeImputationSites()
Takes a dataframe and analyses the imputation sites.
pgu.imputation$analyzeImputationSites(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
imputationSiteIdxByFeature()
Returns the position of an attribute's imputation sites within a data frame.
pgu.imputation$imputationSiteIdxByFeature(featureName = "character")
featureNameThe attribute's name. (character)
The postion of the imputation sites. (numeric)
nanFeatureList()
Characterizes each row of the data frame as either 'complete' or indicates which attribute are missing within the row. If multiple attributes' row entries are missing, the row is characterized by 'multiple'.
pgu.imputation$nanFeatureList(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
Vector of row characteristics. (character)
average_number_of_predictors()
Calculates the average number of predictors for a given dataframe and minpuc and mincor variables using the mice::quickpred routine.
pgu.imputation$average_number_of_predictors( data_df = "tbl_df", minpuc = 0, mincor = 0.1 )
data_dfThe dataframe to be analyzed (tibble::tibble)
minpucSpecifies the minimum threshold for the proportion of usable cases. (numeric)
mincorSpecifies the minimum threshold against which the absolute correlation in the dataframe is compared. (numeric)
Average_number_of_predictors. (numeric)
detectPredictors()
Identifies possible predictors for each feature. Analysis results are written to the instance variable pred_mat. Intermediate analysis results are an influx/outflux dataframe that is written to the instance variable flux_df and detect predictors and a list of features that is excluded from the search for possible predictors that is written to the instance variable exclude_vec.
pgu.imputation$detectPredictors(data_df = "tbl_df")
data_dfThe dataframe to be analyzed. (tibble::tibble)
handleImputationSites()
Chooses a cleaning method based upon the instance variable 'imputationAgent' and handles the imputation sites in the dataframe. Returns a cleaned data set. Display the progress if shiny is loaded.
pgu.imputation$handleImputationSites(data_df = "tbl_df", progress = "Progress")
data_dfThe data frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored within this instance of the shiny Progress class. (shiny::Progress)
Cleaned dataframe. (tibble:tibble)
imputeByMedian()
Substitutes imputation sites by the median of the respective attribute. Returns the cleaned dataframe. Display the progress if shiny is loaded.
pgu.imputation$imputeByMedian(data_df = "tbl_df", progress = "Progress")
data_dfThe data frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
Cleaned dataframe. (tibble:tibble)
imputeByMean()
Substitutes imputation sites by the aritmertic mean of the respective attribute. Returns the cleaned dataframe. Display the progress if shiny is loaded.
pgu.imputation$imputeByMean(data_df = "tbl_df", progress = "Progress")
data_dfThe data frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
Cleaned dataframe. (tibble:tibble)
imputeByExpectationValue()
Substitutes imputation sites by the expectation value of the respective attribute. Returns the cleaned dataframe. Display the progress if shiny is loaded.
pgu.imputation$imputeByExpectationValue( data_df = "tbl_df", progress = "Progress" )
data_dfThe data frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
Cleaned dataframe. (tibble:tibble)
imputeByMC()
Substitutes imputation sites by values generated by a monte carlo simulation. The procedure runs several times as defined by the instance variable 'iterations'. The run with the best result is identified and used for substitution. Returns the cleaned dataframe. Display the progress if shiny is loaded.
pgu.imputation$imputeByMC(data_df = "tbl_df", progress = "Progress")
data_dfThe data frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
Cleaned dataframe. (tibble:tibble)
imputeByKnn()
Substitutes imputation sites by predictions of a KNN analysis of the whole dataframe. Returns the cleaned dataframe. Display the progress if shiny is loaded.
pgu.imputation$imputeByKnn(data_df = "tbl_df", progress = "Progress")
data_dfThe data frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
Cleaned dataframe. (tibble:tibble)
imputeByMice()
Substitutes imputation sites by values generated by a different methods of the mice package. The procedure runs several times as defined by the instance variable 'iterations'. The run with the best result is identified and used for substitution. Returns the cleaned dataframe. Display the progress if shiny is loaded.
pgu.imputation$imputeByMice(data_df, progress = "Progress")
data_dfThe data frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
Cleaned dataframe. (tibble:tibble)
imputeByM5P()
Substitutes imputation sites by predictions of a M5P tree trained on the whole dataframe. Returns the cleaned dataframe. Display the progress if shiny is loaded.
pgu.imputation$imputeByM5P(data_df = "tbl_df", progress = "Progress")
data_dfThe data frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
Cleaned dataframe. (tibble:tibble)
imputationSiteHeatMap()
Displays the distribution of missing values in form of a heatmap.
pgu.imputation$imputationSiteHeatMap()
A heatmap plot. (ggplot2::ggplot)
featureBarPlot()
Displays the distribution of an attribute values as histogram.
pgu.imputation$featureBarPlot(data_df = "tbl_df", feature = "character")
data_dfdataframe to be analyzed. (tibble::tibble)
featureattribute to be shown. (character)
A histogram. (ggplot2::ggplot)
featureBoxPlotWithSubset()
Displays the distribution of an attribute's values as box plot.
pgu.imputation$featureBoxPlotWithSubset( data_df = "tbl_df", feature = "character" )
data_dfdataframe to be analyzed. (tibble::tibble)
featureattribute to be shown. (character)
A box plot. (ggplot2::ggplot)
featurePlot()
Displays the distribution of an attribute's values as a composition of a box plot and a histogram.
pgu.imputation$featurePlot(data_df = "tbl_df", feature = "character")
data_dfdataframe to be analyzed. (tibble::tibble)
featureattribute to be shown. (character)
A composite plot. (ggplot2::ggplot)
fluxPlot()
Displays an influx/outflux plot
pgu.imputation$fluxPlot()
A composite plot. (ggplot2::ggplot)
clone()
The objects of this class are cloneable with this method.
pgu.imputation$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Handles values in the pguIMP dataset that exceed the limits of quantification. This object is used by the shiny based gui and is not for use in individual R-scripts!
R6::R6Class object.
more information
loqReturns the instance variable loq (tibble::tibble)
setLoqSets the instance variable loq (tibble::tibble)
outliersReturns instance variable outliers (tibble::tibble)
lloqSubstituteAlphabetReturns the instance variable lloqSubstititeAlphabet (character)
lloqSubstituteAgentReturns the instance variable lloqSubstituteAgent (character)
setLloqSubstituteAgentSets the instance variable lloqSubstituteAgent (character)
uloqSubstituteAlphabetReturns the instance variable uloqSubstititeAlphabet (character)
uloqSubstituteAgentReturns the instance variable uloqSubstituteAgent (character)
setUloqSubstituteAgentSets the instance variable uloqSubstituteAgent (character)
naHandlingAlphabetReturns the instance variable naHandlingAlphabet (character)
naHandlingAgentReturns the instance variable naHandlingAgent (character)
setNaHandlingAgentSets the instance variable naHandlingAgent (character)
loqStatisticsReturns the instance variable loqStatistics
The following public methods are available:
- 'new()': Creates a new pgu.limitsOfQuantification object - 'print()': Prints instance variables - 'reset()': Resets the object - 'fit()': Analyzes data for LOQ violations - 'predict()': Applies LOQ corrections - 'attribute_lloq()', 'attribute_uloq()': Get LOQ values - 'set_attribute_lloq()', 'set_attribute_uloq()': Set LOQ values - 'attribute_outliers()': Get outliers for an attribute - 'plot_loq_distribution()': Plot LOQ statistics - 'attribute_bar_plot()', 'attribute_box_plot_with_subset()', 'attribute_plot()': Create diagnostic plots - 'clone()': Clone the object
Sebastian Malkusch
Other pguIMP classes: pgu.missings
Detects and substitutes missing values from data set.
R6::R6Class object.
Detects missing values in the transformed and normalized data set. This object is used by the shiny based gui and is not for use in individual R-scripts!
imputationParameterReturns the instance variable imputationParameter (tibble::tibble)
imputationSitesReturns the instance variable imputationSites (tibble::tibble)
one_hot_dfReturns the positions of missings in one_hot encoding (tibble::tibble)
amvReturns the instance variable amv (numeric)
The following public methods are available:
- 'new()': Creates a new pgu.missings object - 'print()': Prints instance variables - 'resetImputationParameter()': Resets imputation parameters - 'featureIdx()': Get feature position - 'filterFeatures()': Filter features with missings - 'gatherMeasurements()', 'gatherMissings()', 'gatherExistings()', 'gatherFractionOfMissings()': Gather missing value statistics - 'gatherImputationStatistics()': Collect imputation statistics - 'one_hot()': Create one-hot encoding of missings - 'detectImputationSites()': Detect missing value positions - 'imputationSiteDistribution()': Get missing value distribution - 'imputationSiteHeatMap()': Create missing value heatmap - 'clone()': Clone the object
Sebastian Malkusch
Other pguIMP classes: pgu.limitsOfQuantification
A class that characterizes the origin of missing values.
[R6::R6Class] object.
A class that characterizes the origin of missing values. This object is used by the shiny based gui and is not for use in individual R-scripts!
featureAlphabetReturns the instance variable featureAlphabet. (character)
featureAgentReturns the instance variable featureAgent. (character)
setFeatureAgentSets the instance variable featureAgent. (character)
missingsCharacteristics_dfReturns the instance variable missingsCharacteristics_df. (tibble::tibble)
new()
Creates and returns a new 'pgu.missingsCharacterizer' object.
pgu.missingsCharacterizer$new(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
A new 'pgu.missingsCharacterizer' object. (pguIMP::pgu.missingsCharacterizer)
finalize()
Clears the heap and indicates if instance of 'pgu.missingsCharacterizer' is removed from heap.
pgu.missingsCharacterizer$finalize()
print()
Prints instance variables of a 'pgu.missingsCharacterizer' object.
pgu.missingsCharacterizer$print()
string
reset()
Takes a dataframe that will be analyzed using the analyze function and resets the instance variables.
pgu.missingsCharacterizer$reset(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
analyze()
resets the instance variables and analyzes a dataframe.
pgu.missingsCharacterizer$analyze(data_df = "tbl_df", progress = "Progress")
data_dfThe data to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored within this instance of the shiny Progress class. (shiny::Progress)
plot_pair_dist()
Plots the analysis result.
pgu.missingsCharacterizer$plot_pair_dist(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
clone()
The objects of this class are cloneable with this method.
pgu.missingsCharacterizer$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Comprises a list of models for data manipulation.
[R6::R6Class] object.
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!
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.
Sebastian Malkusch
Normalization of data. Part of pguIMP.
[R6::R6Class] object.
Performs a data normalization in order to achieve a standardized version of the dataframe. This object is used by the shiny based gui and is not for use in individual R-scripts!
normAgentAlphabetReturns the instance variable normAgentAlphabt.
normAgentReturns the instance variable normAgent. (character)
setNormAgentSets the instance variable normAgent. (character)
featuresReturns instance variable features. (character)
normParameterReturns the instance variable normParameter.
new()
Creates and returns a new 'pgu.normalizer' object.
pgu.normalizer$new(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
A new 'pgu.normalizer' object. (pguIMP::pgu.normalizer)
finalize()
Clears the heap and indicates that instance of 'pgu.normalizer' is removed from heap.
pgu.normalizer$finalize()
print()
Prints instance variables of a 'pgu.normalizer' object.
pgu.normalizer$print()
string
detectNormParameter()
Resets instance variable 'normParameter'
pgu.normalizer$detectNormParameter(data_df = "tbl_df")
data_dfDataframe to be analyzed. (tibble::tibble)
scale_data()
Scales a tibble using the method defined by the instance variable normAgent
pgu.normalizer$scale_data(data_df = "tbl_df")
data_dfDataframe to be scaled (tible::tibble)
A normalized version of the dataframe. (tibble::tibble)
scale_minMax()
Scales a tibble using min-max normalization
pgu.normalizer$scale_minMax(data_df = "tbl_df")
data_dfDataframe to be scaled (tibble::tibble)
A min-max normalized version of the dataframe
scale_minMax_numeric()
Scales a numeric object using min-max normalization
pgu.normalizer$scale_minMax_numeric(values = "numeric", feature = "character")
valuesValues to be scaled. Either a number or a vector (numeric)
featureCharacter to idtentify the proper normalization parameters. (character)
A min-max normalized version of the numeric object
scale_mean()
Scales a tibble using mean normalization
pgu.normalizer$scale_mean(data_df = "tbl_df")
data_dfDataframe to be scaled. (tibble::tibble)
A mean normalized version of the dataframe
scale_mean_numeric()
Scales a numeric object using mean normalization
pgu.normalizer$scale_mean_numeric(values = "numeric", feature = character)
valuesValues to be scaled. Either a number or a vector (numeric)
featureCharacter to idtentify the proper normalization parameters. (character)
A mean normalized version of the numeric object
scale_zScore()
Scales a tibble using z-score normalization
pgu.normalizer$scale_zScore(data_df = "tbl_df")
data_dfDataframe to be scaled (tibble::tibble)
A z-score normalized version of the dataframe
scale_zScore_numeric()
Scales a numeric object using z-score normalization
pgu.normalizer$scale_zScore_numeric(values = "numeric", feature = character)
valuesValues to be scaled. Either a number or a vector (numeric)
featureCharacter to idtentify the proper normalization parameters. (character)
A z-score normalized version of the numeric object
rescale_data()
Rescales a tibble using the method defined by the instance variable normAgent
pgu.normalizer$rescale_data(data_df = "tbl_df")
data_dfNormalized dataframe to be rescaled (tible::tibble)
A rescaled version of the normalized dataframe. (tibble::tibble)
rescale_minMax()
Rescales a tibble using min-max normalization
pgu.normalizer$rescale_minMax(data_df = "tbl_df")
data_dfNormalized dataframe to be rescaled (tibble::tibble)
A rescaled version of a min-max normalized dataframe
rescale_minMax_numeric()
Rescales a numeric object using min-max normalization
pgu.normalizer$rescale_minMax_numeric(values = "numeric", feature = character)
valuesNormalized values to be rescaled. Either a number or a vector (numeric)
featureCharacter to idtentify the proper normalization parameters. (character)
Rescaled version of min-max normalized numeric object
rescale_mean()
Rescales a tibble using mean normalization
pgu.normalizer$rescale_mean(data_df = "tbl_df")
data_dfNormalized dataframe to be rescaled (tibble::tibble)
A rescaled version of a mean normalized dataframe
rescale_mean_numeric()
Rescales a numeric object using mean normalization
pgu.normalizer$rescale_mean_numeric(values = "numeric", feature = character)
valuesNormalized values to be rescaled. Either a number or a vector (numeric)
featureCharacter to idtentify the proper normalization parameters. (character)
Rescaled version of mean normalized numeric object
rescale_zScore()
Rescales a tibble using z-score normalization
pgu.normalizer$rescale_zScore(data_df = "tbl_df")
data_dfNormalized dataframe to be rescaled (tibble::tibble)
A rescaled version of a z-score normalized dataframe
rescale_zScore_numeric()
Rescales a numeric object using z-score normalization
pgu.normalizer$rescale_zScore_numeric(values = "numeric", feature = character)
valuesNormalized values to be rescaled. Either a number or a vector (numeric)
featureCharacter to idtentify the proper normalization parameters. (character)
Rescaled version of z-score normalized numeric object
featureBarPlot()
Displays the distribution of an attribute values as histogram.
pgu.normalizer$featureBarPlot(data_df = "tbl_df", feature = "character")
data_dfdataframe to be analyzed. (tibble::tibble)
featureattribute to be shown. (character)
A histogram. (ggplot2::ggplot)
featureBoxPlotWithSubset()
Displays the distribution of an attribute's values as box plot.
pgu.normalizer$featureBoxPlotWithSubset( data_df = "tbl_df", feature = "character" )
data_dfdataframe to be analyzed. (tibble::tibble)
featureattribute to be shown. (character)
A box plot. (ggplot2::ggplot)
featurePlot()
Displays the distribution of an attribute's values as a composition of a box plot and a histogram.
pgu.normalizer$featurePlot(data_df = "tbl_df", feature = "character")
data_dfdataframe to be analyzed. (tibble::tibble)
featureattribute to be shown. (character)
A composite plot. (ggplot2::ggplot)
clone()
The objects of this class are cloneable with this method.
pgu.normalizer$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Compares the distribution of a single attribute's values to normal distribution by using several statistic tests.
[R6::R6Class] object.
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!
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)
new()
Creates and returns a new 'pgu.normDist' object.
pgu.normDist$new(data = "tbl_df")
dataThe data to be analyzed. (tibble::tibble)
A new 'pgu.normDist' object. (pguIMP::pgu.normDist)
finalize()
Clears the heap and indicates that instance of 'pgu.normDist' is removed from heap.
pgu.normDist$finalize()
print()
Prints instance variables of a 'pgu.normDist' object.
pgu.normDist$print()
string
resetNormDist()
Resets instance variables
pgu.normDist$resetNormDist(data = "tbl_df")
dataDataframe to be analyzed. (tibble::tibble)
resetFail()
Resets instance variables in case of a failed analysis.
pgu.normDist$resetFail()
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 is calculated subsequently.
pgu.normDist$optimize()
createHistogram()
Creates a histogram from the instance variable 'rawData'. The histogram is stored in the instance variable 'histogram'.
pgu.normDist$createHistogram()
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'.
pgu.normDist$normalQQData()
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'
pgu.normDist$test.shapiro()
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'
pgu.normDist$test.kolmogorow()
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'
pgu.normDist$test.anderson()
fitResult()
Returns the result of the classes optimize function in form of a formated string.
pgu.normDist$fitResult()
String of the results of the fitting routine (character)
testResult()
Returns the result of the classes test functions in form of a formated string.
pgu.normDist$testResult(testName = "Shapiro-Wilk")
testNameDefines the test which result shall be returned. Can be of type:'Shapiro-Wilk', 'Kolmogorow-Smirnow' or 'Anderson-Darling'. (character)
String of the results of the testing routine (character)
testResultCompendium()
Returns the result of the classes test functions 'Shapiro-Wilk', 'Kolmogorow-Smirnow' and 'Anderson-Darling' in form of a formated string. (character)
pgu.normDist$testResultCompendium()
String of the results of the testing routine (character)
plotHistogram()
Displays the instance variable 'histogram' in form of a bar plot and overlays the corresponding normal distribution.
pgu.normDist$plotHistogram()
A bar plot. (ggplot2::ggplot)
plotResiduals()
Displays the residuals between the instance variable 'histogram' and the corresponding normal distribution.
pgu.normDist$plotResiduals()
A scatter plot. (ggplot2::ggplot)
plotResidualDist()
Displays the distribution of the residuals between the distribution of the instance variable 'histogram' in form of a histogram.
pgu.normDist$plotResidualDist()
A bar plot. (ggplot2::ggplot)
plotRawResidualDist()
Displays the distribution of the residuals between the distribution of the instance variable 'rawData' in form of a histogram.
pgu.normDist$plotRawResidualDist()
A bar plot. (ggplot2::ggplot)
plotRawDataDist()
Displays the distribution of the instance variable 'rawData' in form of a histogram.
pgu.normDist$plotRawDataDist()
A bar plot. (ggplot2::ggplot)
normalQQPlot()
Displays a qqplot of the instance variable 'rawData'.
pgu.normDist$normalQQPlot()
A qq-plot. (ggplot2::ggplot)
fit()
Runs the optimization process and performs all implemented quality controls. Additionally performs hypothesis tests for normality.
pgu.normDist$fit()
clone()
The objects of this class are cloneable with this method.
pgu.normDist$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Finds the transformation models that result in distributions that come closest to a normal distribution.
[R6::R6Class] object.
Analysis is performed individually on each attribute. This object is used by the shiny based gui and is not for use in individual R-scripts!
featuresReturns the instance variable features. (character)
trafoAlphabetReturns the instance variable trafoAlphabet. (character)
setTrafoAlphabetSets the instance variable trafoAlphabet to data. (character)
mirrorReturns the instance variable mirror (logical)
setMirrorSets the instance variable mirror to data (logical)
optParameterReturns the instance variable optParameter (tibble::tibble)
optTypesReturns the instance variable optTypes (tibble::tibble)
new()
Creates and returns a new 'pgu.optimizer' object.
pgu.optimizer$new(data = "tbl_df")
dataThe data to be analyzed. (tibble::tibble)
A new 'pgu.optimizer' object. (pguIMP::pgu.optimizer)
finalize()
Clears the heap and indicates that instance of 'pgu.optimizer' is removed from heap.
pgu.optimizer$finalize()
print()
Prints instance variables of a 'pgu.optimizer' object.
pgu.optimizer$print()
string
resetFeatures()
Extract the attribute names from the given data frame and stores them in the class' instance variable features,
pgu.optimizer$resetFeatures(data = "tbl_df")
dataThe data to be analyzed. (tibble::tibble)
resetOptParameter()
Initializes the instance variable optParameter.
pgu.optimizer$resetOptParameter()
resetOptTypes()
Initializes the instance variable optTypes.
pgu.optimizer$resetOptTypes()
resetOptimizer()
Initializes the optimizer instance variables. Here, initialization defines a consecutive sequence of the class' functions: resetFeatures, setTrafoAlphabet, setMirror, resetOptParameter and resetOptTypes.
pgu.optimizer$resetOptimizer(data = "tbl_df")
dataThe data to be analyzed. (tibble::tibble)
featureIdx()
Determines the numerical index of the column of an attribute based on the attribute name.
pgu.optimizer$featureIdx(feature = "character")
featureThe attribute's name. (character)
The attributes column index. (numeric)
modelParameterIsBigger()
Compares a model parameter to a reference parameter and tests, if the model parameter is bigger.
pgu.optimizer$modelParameterIsBigger( modelParameter = "numeric", referenceParameter = "numeric" )
modelParameterThe model parameter (numeric)
referenceParameterThe reference parameter (numeric)
Test Result (logical)
modelParameterIsSmaller()
Compares a model parameter to a reference parameter and tests, if the model parameter is smaller.
pgu.optimizer$modelParameterIsSmaller( modelParameter = "numeric", referenceParameter = "numeric" )
modelParameterThe model parameter (numeric)
referenceParameterThe reference parameter (numeric)
Test Result (logical)
updateTrafoType()
Takes an instance of the pgu.transfromator class and sets the transformation type to a user defined value.
pgu.optimizer$updateTrafoType( transformator = "pgu.transformator", type = "character" )
transformatorAn instance of the pgu.transformator class (pguIMP::pgu.transformator)
typeA transfromation type (character)
An updated instance of the pgu.transformator class (pguIMP::pgu.transformator)
updateMirrorLogic()
Takes an instance of the pgu.transfromator class and sets the mirrorLogic parameter to a user defined value.
pgu.optimizer$updateMirrorLogic( transformator = "pgu.transformator", logic = "logical" )
transformatorAn instance of the pgu.transformator class (pguIMP::pgu.transformator)
logicThe mirrorLogic parameter (logic)
An updated instance of the pgu.transformator class (pguIMP::pgu.transformator)
updateOptParameter()
Takes an instance of the pgu.model class and analyzes it. Keeps track of the optimal model parameters during optimization and stores them in the instance variables optTypes and optParameter.
pgu.optimizer$updateOptParameter( model = "pgu.model", type = "character", logic = "character" )
modelAn instance of the pgu.model class (pguIMP::pgu.model)
typeA transfromation type (character)
logicThe mirrorLogic parameter (logic)
optimize()
Permutates all possible variations of data transfromations and iterates through them. Analysis the optimal transformation parameters for each attribute in the data frame and stores them in the instance variables optParameter, optTypes.
pgu.optimizer$optimize(data = "tbl_df", progress = "Progress")
dataThe data frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored within this instance of the shiny Progress class. (shiny::Progress)
trafoAlpahbetTblDf()
Returns information on the optimization progress
pgu.optimizer$trafoAlpahbetTblDf()
The data frame comprizing analysis information. (tibble::tibble)
clone()
The objects of this class are cloneable with this method.
pgu.optimizer$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Detects and replaces possible outliers from data set.
[R6::R6Class] object.
Performes Grubb's test for outliers to detect outliers in the normalized and Z-score transfromed data set. Replace missing values with substitutes by classical and AI-powerd substitution algorithms. For this purpose outliers are handled as imputation sites.
outliersParameterReturns the instance variable outliersParameter. (tibble::tibble)
outliersReturns the instance variable outliers. (tibble::tibble)
one_hot_dfReturns the positions of missings in one_hot encoding (tibble::tibble)
outliersStatisticsReturns the instance variable outliersStatistics. (tibble::tibble)
outliersAgentAlphabetReturns the instance variable of outliersAgentAlphabet (character)
outliersAgentReturns the instance variable outliersAgent. (character)
setOutliersAgentSets the instance variable outliersAgent. (character)
featureDataReturns the instance variable featureData. (numeric)
alphaReturns the instance variable alpha. (numeric)
setAlphaSet the instance variable alpha. (numeric)
epsilonReturns the instance variable epsilon. (numeric)
setEpsilonSet the instance variable epsilon. (numeric)
minSamplesReturns the instance variable minSamples. (integer)
setMinSamplesSet the instance variable minSamples. (integer)
gammaReturns the instance variable gamma. (numeric)
setGammaSet the instance variable gamma. (numeric)
nuReturns the instance variable nu. (numeric)
setNuSet the instance variable nu. (numeric)
kReturns the instance variable k (integer)
setKSets the instance variable k. (integer)
cutoffReturns the instance variable cutoff. (numeric)
setCutoffSets the instance variable cutoff. (numeric)
seedReturns the instance variable seed. (integer)
setSeedSet the instance variable seed. (integer)
new()
Creates and returns a new 'pgu.outliers' object.
pgu.outliers$new( data_df = "tbl_df", alpha = 0.05, epsilon = 0.1, minSamples = 4, gamma = 0.05, nu = 0.1, k = 4, cutoff = 0.99, seed = 42 )
data_dfThe data to be cleaned. (tibble::tibble)
alphaInitial definition of the instance variable alpha. (numeric)
epsilonInitial definition of the instance variable epsilon. (numeric)
minSamplesInitial definition of the instance variable minSamples. (integer)
gammaInitial definition of the instance variable gamma. (numeric)
nuInitial definition of the instance variable nu. (numeric)
kInitial definition of the instance variable k. (integer)
cutoffInitial definition of the instance variable cutoff. (numeric)
seedInitial definition of the instance variable seed. (integer)
A new 'pgu.outliers' object. (pguIMP::pgu.outliers)
finalize()
Clears the heap and indicates that instance of 'pgu.outliers' is removed from heap.
pgu.outliers$finalize()
print()
Prints instance variables of a 'pgu.outliers' object.
pgu.outliers$print()
string
resetOutliers()
Resets instance variables and performes Grubb's test for outliers to detect outliers in the normalized and Z-score transfromed data set. Progresse is indicated by the progress object passed to the function.
pgu.outliers$resetOutliers(data_df = "tbl_df")
data_dfDataframe to be analyzed. (tibble::tibble)
filterFeatures()
Filters attributes from the given dataframe that are known to the class.
pgu.outliers$filterFeatures(data_df = "tbl_df")
data_dfDataframe to be filtered. (tibble::tibble)
A filterd dataframe. (tibble::tibble)
checkFeatureValidity()
Checks if the feature consists of a sufficient number of instances.
pgu.outliers$checkFeatureValidity(data_df = "tbl_df", feature = "character")
data_dfDataframe to be analyzed (tibble::tibble)
featureThe attribute to be analyzed. (character)
detectOutliersParameter()
determines the outliers parameter by analyzing the tibble data_df and the instance variable outliers. Results are stored to instance variable outliersParameter.
pgu.outliers$detectOutliersParameter(data_df = "tbl_df")
data_dfDataframe to be analyzed. (tibble::tibble)
outliersFeatureList()
Characterizes each row of the data frame as either 'complete' or indicates which attribute has been identified as an outlier within the row. If multiple attributes' row entries were identified as outliers, the row is characterized by 'multiple'.
pgu.outliers$outliersFeatureList(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
Vector of row characteristics. (character)
featureOutlier()
Returns the detected outliers of a given attribute.
pgu.outliers$featureOutlier(feature = "character")
featureThe attribute to be analyzed (character)
The attribute's outliers (tibble::tibble)
one_hot()
Gathers statistical information about missing values in one hot format. The result is stored in the instance variable one_hot_df.
pgu.outliers$one_hot(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
detectOutliers()
Chooses a method for identification of anomalies based upon the instance variable 'outliersAgent' Detects anomalies in a data frame by one-dimensional analysis of each feature.
pgu.outliers$detectOutliers(data_df = "tbl_df", progress = "Progress")
data_dfData frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
detectByGrubbs()
Identifies anomalies in the data frame based on Grubb's test. Iterates over the whole data frame. Calls the object's public function 'grubbs_numeric' until no more anomalies are identified. The threshold for anomaly detection is defined in the instance variable 'alpha'. Display the progress if shiny is loaded.
pgu.outliers$detectByGrubbs(data_df = "tbl_df", progress = "Progress")
data_dfData frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
grubbs_numeric()
Performs Grubb's test for anomalies to detect a single outlier in the provided attributes data. If an outlier is found, it is added to the instance variable 'outliers'. The threshold for anomaly detection is difined in the instance variable 'alpha'. The function indicates a find by a positive feedback.
pgu.outliers$grubbs_numeric(data_df = "tbl_df", feature = "character")
data_dfThe data frame to be analyzed. (tibble::tibble)
featureThe attribute within the data frame to be analyzed.
Feedback if an outlier was found. (logical)
detectByDbscan()
Identifies anomalies in the data frame based on DBSCAN. Iterates over the whole data frame. Calls the object's public function 'dbscan_numeric' until all features are analyzed. The cluster hyper parameter are defined in the instance variables 'epsilon' and 'minSamples'. The results of the 'dbscan_numeric' routine are added to the instance variable 'outliers'. Display the progress if shiny is loaded.
pgu.outliers$detectByDbscan(data_df = "tbl_df", progress = "Progress")
data_dfData frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
dbscan_numeric()
Identifies anomalies in a single feature of a data frame based on DBSCAN. The cluster hyperparameter are defined in the instance variables 'epsilon' and 'minSamples'. Display the progress if shiny is loaded.
pgu.outliers$dbscan_numeric(data_df = "tbl_df", feature = "character")
data_dfData frame to be analyzed. (tibble::tibble)
featureFeature to be analyzed (character)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
A data frame comprising the information about detected anomalies of the feature. (tibble::tibble)
detectBySvm()
Identifies anomalies in the data frame based on one class SVM. Iterates over the whole data frame. Calls the object's public function 'svm_numeric' until all features are analyzed. The cluster hyper parameter are defined in the instance variables 'gamma' and 'nu'. The results of the 'svm_numeric' routine are added to the instance variable 'outliers'. Display the progress if shiny is loaded.
pgu.outliers$detectBySvm(data_df = "tbl_df", progress = "Process")
data_dfData frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
svm_numeric()
Identifies anomalies in a single feature of a data frame based on one class SVM. The cluster hyperparameter are defined in the instance variables 'gamma' and 'nu'. Display the progress if shiny is loaded.
pgu.outliers$svm_numeric(data_df = "tbl_df", feature = "character")
data_dfData frame to be analyzed. (tibble::tibble)
featureFeature to be analyzed (character)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
A data frame comprising the information about detected anomalies of the feature. (tibble::tibble)
detectByKnn()
Identifies anomalies in the data frame based on knnO. Iterates over the whole data frame. Calls the object's public function 'svm_numeric' until all features are analyzed. The cluster hyper parameter are defined in the instance variables 'alpha' and 'minSamples'. The results of the 'knn_numeric' routine are added to the instance variable 'outliers'. Display the progress if shiny is loaded.
pgu.outliers$detectByKnn(data_df = "tbl_df", progress = "Process")
data_dfData frame to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
knn_numeric()
Identifies anomalies in a single feature of a data frame based on knnO. The cluster hyperparameter are defined in the instance variables 'alpha' and 'minSmaples'. Display the progress if shiny is loaded.
pgu.outliers$knn_numeric(data_df = "tbl_df", feature = "character")
data_dfData frame to be analyzed. (tibble::tibble)
featureFeature to be analyzed (character)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
A data frame comprising the information about detected anomalies of the feature. (tibble::tibble)
setImputationSites()
Replaces the detected anomalies of a user provided data frame with 'NA' for further imputation routines.
pgu.outliers$setImputationSites(data_df = "tbl_df")
data_dfData frame to be mutated. (tibble::tibble)
A data frame with anomalies replaced by 'NA'. (tibble::tibble)
calcOutliersStatistics()
Calculates the statistics on the previously performed outlier detection analysis and stores the results in the instance variable 'outliersStatistcs'.
pgu.outliers$calcOutliersStatistics(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
outlierTable()
Creates a datatable with substituted outliers highlightes by colored background.
pgu.outliers$outlierTable(data_df = "tbl_df")
data_dfThe data frame to be analyzed. (tibble::tibble)
A colored datatable (DT::datatable)
plotOutliersDistribution()
Displays the occurrence of outlier candidates per attribute as bar plot.
pgu.outliers$plotOutliersDistribution()
A bar plot. (ggplot2::ggplot)
featureBarPlot()
Displays the distribution of an attribute's values as histogram.
pgu.outliers$featureBarPlot(data_df = "tbl_df", feature = "character")
data_dfdataframe to be analyzed. (tibble::tibble)
featureattribute to be shown. (character)
A histogram. (ggplot2::ggplot)
featureBoxPlotWithSubset()
Displays the distribution of an attribute's vlues as box plot.
pgu.outliers$featureBoxPlotWithSubset( data_df = "tbl_df", feature = "character" )
data_dfdataframe to be analyzed. (tibble::tibble)
featureattribute to be shown. (character)
A box plot. (ggplot2::ggplot)
featurePlot()
Displays the distribution of an attribute's values as a composition of a box plot and a histogram.
pgu.outliers$featurePlot(data_df = "tbl_df", feature = "character")
data_dfdataframe to be analyzed. (tibble::tibble)
featureattribute to be shown. (character)
A composite plot. (ggplot2::ggplot)
clone()
The objects of this class are cloneable with this method.
pgu.outliers$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
A class that performs pairwise robust regression on the pguIMP data set.
[R6::R6Class] object.
A class that performs pairwise robust regression on the pguIMP data set. This object is used by the shiny based gui and is not for use in individual R-scripts!
featureNamesReturns the instance variable featureNames. (character)
setFeatureNamesSets the instance variable featureNames. It further initializes the instance variables: intercept, pIntercept, slope, pSlope. (character)
interceptReturns the instance variable intercept. (matrix)
pInterceptReturns instance variable pIntercept. (matrix)
slopeReturns the instance variable slope. (matrix)
pSlopeReturns the instance variable pSlope. (matrix)
modelReturns the instance variable model. (robust::lmRob)
new()
Creates and returns a new 'pgu.regressor' object.
pgu.regressor$new(data = "tbl_df")
dataThe data to be modeled. (tibble::tibble)
A new 'pgu.regressor' object. (pguIMP::pgu.regressor)
finalize()
Clears the heap and indicates if instance of 'pgu.regressor' is removed from heap.
pgu.regressor$finalize()
print()
Prints instance variables of a 'pgu.regressor' object.
pgu.regressor$print()
string
resetRegressor()
Performes pair-wise robust linear regression on the attributes of the data tibble. Progresse is indicated by the progress object passed to the function.
pgu.regressor$resetRegressor(data = "tbl_df", progress = "Progress")
dataDataframe with at least two numeric attributes. (tibble::tibble)
progressKeeps track of the analysis progress. (shiny::Progress)
resetDiagonal()
Sets the diagonal of a square matrix to NA.
pgu.regressor$resetDiagonal(data = "matrix")
dataThe matrix whose diagonal is to be reset. (matrix)
A matrix with its diagonal reset to NA. (matrix)
resetMatrix()
Creates a square matrix which dimension corresponds to the length of the instance variable featureNames. The matrix entries are set to a distict 'value'. The diagonal is set to NA.
pgu.regressor$resetMatrix(value = "numeric")
valueThe value the matrix entries are set to. (numeric)
A square matrix. (matrix)
featureIdx()
Determines the numerical index of the column of an attribute based on the attribute name.
pgu.regressor$featureIdx(feature = "character")
featureThe attribute's name. (character)
The attributes column index. (numeric)
featureIsValid()
Checks if the feature is known to the class.
pgu.regressor$featureIsValid(feature = "character")
featureAn attribute's name that is to be checked. (character)
The test result. (logical)
featurePairIsValid()
Checks a if a pair of attributes different and known to the class.
pgu.regressor$featurePairIsValid( abscissa = "character", ordinate = "character" )
abscissaAn attribute's name that is to be checked. (character)
ordinateAn attribute's name that is to be checked. (character)
The test result. (logical)
createModel()
Creates a robust model of linear regression between two attributes of a dataframe. The model is stored as instance variable.
pgu.regressor$createModel( data = "tbl_df", abscissa = "character", ordinate = "character" )
dataThe data to be modeled. (tibble::tibble)
abscissaAn attribute's name that equals a column name in the data. (character)
ordinateAn attribute's name that equals a column name in the data. (character)
createRegressionMatrix()
Performs the actual robust linear regression routine. Iteratively runs through the attributes known to the class and creates a robust linear regression model for each valid attribute pair. The model results are stored in the instance variables: intercept, pIntercept, slope, pSlope. Here, pX represents the p-value of the respective parameter X. Displays the progress if shiny is loaded.
pgu.regressor$createRegressionMatrix(data = "tbl_df", progress = "Progress")
dataThe data to be modeled. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored within this instance of the shiny Progress class. (shiny::Progress)
printModel()
Transforms the results of the modeling procedure for a valid pair of attributes to a dataframe and returns it.
pgu.regressor$printModel(abscissa = "character", ordinate = "character")
abscissaThe name of the attribute which is assigned to the abscissa. (character)
ordinateThe name of the attribute which is assigned to the ordinate. (character)
The analyis result as a dataframe. (tibble::tibble)
printInterceptTbl()
Transfroms instance variable intercept to a dataframe and returns it.
pgu.regressor$printInterceptTbl()
Dataframe of instance variable intercept. (tibble::tibble)
printPInterceptTbl()
Transfroms instance variable pIntercept to a dataframe and returns it.
pgu.regressor$printPInterceptTbl()
Dataframe of instance variable pIntercept. (tibble::tibble)
printSlopeTbl()
Transfroms instance variable slope to a dataframe and returns it.
pgu.regressor$printSlopeTbl()
Dataframe of instance variable slope. (tibble::tibble)
printPSlopeTbl()
Transfroms instance variable pSlope to a dataframe and returns it.
pgu.regressor$printPSlopeTbl()
Dataframe of instance variable pSlope. (tibble::tibble)
plotRegression()
Creates a scatter plot of the model stored within the instance variable of the class.
pgu.regressor$plotRegression()
A scatter plot. (ggplot2::ggplot)
plotResidualDist()
Creates a histogram of the residual distribution of the model stored within the instance variable of the class.
pgu.regressor$plotResidualDist()
A histogram plot. (ggplot2::ggplot)
plotResidualBox()
Creates a box plot of the residual distribution of the model stored within the instance variable of the class.
pgu.regressor$plotResidualBox()
A box plot. (ggplot2::ggplot)
plotModel()
Creates a model of robust linear regression. Executes all graphical exploration functions of the class and creates a composite graph based on their results.
pgu.regressor$plotModel( data = "tbl_df", abscissa = "character", ordinate = "character" )
dataThe data to be modeled. (tibble::tibble)
abscissaThe name of the attribute which is assigned to the abscissa. (character)
ordinateThe name of the attribute which is assigned to the ordinate. (character)
A composite graph. (gridExtra::grid.arrange)
clone()
The objects of this class are cloneable with this method.
pgu.regressor$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Creates a human readable report file of the pguIMP analysis in odf format via rmarkdown and latex. This object is used by the shiny based gui and is not for use in individual R-scripts!
[R6::R6Class] object.
I run at the end of the analysis.
filenameReturns the instance variable filename (character)
setFilenameSets the instance variable filename to name. (character)
new()
Creates and returns a new 'pgu.reporter' object.
pgu.reporter$new(name = "character")
nameFilename of the report pdf. (character)
A new 'pgu.reporter' object. (pguIMP::pgu.report)
finalize()
Clears the heap and indicates that instance of 'pgu.reporter' is removed from heap.
pgu.reporter$finalize()
print()
Prints instance variables of a 'pgu.reporter' object.
pgu.reporter$print()
string
write_report()
Writes a report of the pguIMP analysis to a pdf file.
pgu.reporter$write_report(obj)
objA list of class objects that are passed to the rmarkdown script.
t.b.a.
clone()
The objects of this class are cloneable with this method.
pgu.reporter$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
A class that keeps track of the pguIMP analysis process.
[R6::R6Class] object.
pguIMP uses a defined linear analysis path The current status therefore provides information about which analyses have already been performed and which still have to be performed. This way pguIMG knows any time during analysis, if all necessary information for the next desired analysis step are available. This object is used by the shiny based gui and is not for use in individual R-scripts!
processAlphabetReurns the process alphabet of the pguIMP analysis routine. (character)
processStatusReturns the process status of the pguIMP routine. (logical)
new()
Creates and returns a new 'pgu.status“ object.
pgu.status$new()
A new 'pgu.status' object. (pguIMP::pgu.status)
finalize()
Clears the heap and indicates if instance of 'pgu.status' is removed from heap.
pgu.status$finalize()
print()
Prints instance variables of a 'pgu.status' object.
pgu.status$print()
string
reset()
resets the intance variables 'processAlphabet' and 'processStatus' to their initial values (FALSE).
pgu.status$reset()
update()
updates the process status
pgu.status$update(processName = "character", value = "logical")
processNameThe name of the 'pguIMP' process that has been performed. (character)
valueIndicates if the process ended with success. (logical)
query()
Queries if a process has already been performed successfully.
pgu.status$query(processName = "character")
processNameName of the process to be checked. (character)
Status of the queried process (logical)
clone()
The objects of this class are cloneable with this method.
pgu.status$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Transforms the data of pguIMP.
[R6::R6Class] object.
Performs a data transformation in order to achieve a normally distributed version of the dataframe. This object is used by the shiny based gui and is not for use in individual R-scripts!
trafoAlphabetReturns the instance variable trafoAlphabte.
trafoParameterReturns the instance variable trafoParameter.
new()
Creates and returns a new 'pgu.transformator' object.
pgu.transformator$new(data_df = "tbl_df")
data_dfThe data to be analyzed. (tibble::tibble)
A new 'pgu.transformator' object. (pguIMP::pgu.transformator)
finalize()
Clears the heap and indicates that instance of 'pgu.transformator' is removed from heap.
pgu.transformator$finalize()
print()
Prints instance variables of a 'pgu.transformator' object.
pgu.transformator$print()
string
resetTrafoParameter()
Resets instance variable 'trafoParameter'
pgu.transformator$resetTrafoParameter(data = "tbl_df")
dataDataframe to be analyzed. (tibble::tibble)
trafoType()
Returns entry of 'trafoType' for user defined attribute.
pgu.transformator$trafoType(feature = "character")
featureAttribute's name. (character)
Value of entry. (character)
setTrafoType()
Sets entry of 'trafoType' for user defined attribute.
pgu.transformator$setTrafoType(feature = "character", type = "character")
featureAttribute's name. (character)
typeTrafo type parameter. Valid choices are: "none", "exponential", "log2", "logNorm", "log10", "arcsine", "tukeyLOP", "boxCox". (character)
addConstant()
Returns entry of 'addConst' for user defined attribute.
pgu.transformator$addConstant(feature = "character")
featureAttribute's name. (character)
Value of entry. (numeric)
mirrorLogic()
Returns entry of 'mirrorLogic' for user defined attribute.
pgu.transformator$mirrorLogic(feature = "character")
featureAttribute's name. (character)
Value of entry. (logical)
setMirrorLogic()
Sets entry of 'mirrorLogic' for user defined attribute.
pgu.transformator$setMirrorLogic(feature = "character", logic = "logical")
featureAttribute's name. (character)
logicSpecifies whether the data should be mirrored at the coordinate origin. (logical)
lambdaLOP()
Returns entry of 'lambda_lop' for user defined attribute. Lambda is a specific optimization parameter that is derived from the Tukey-LOP transfromation procedure.
pgu.transformator$lambdaLOP(feature = "character")
featureAttribute's name. (character)
Value of entry. (numeric)
setLambdaLOP()
Sets entry of 'lambda_lop' for user defined attribute.
pgu.transformator$setLambdaLOP(feature = "character", lambda = "numeric")
featureAttribute's name. (character)
lambdaSets the feature specific exponential value. (numeric)
lambdaBC()
Returns entry of 'lambda_bc' for user defined attribute. Lambda is a specific optimization parameter that is derived from the Box-Cox transfromation procedure.
pgu.transformator$lambdaBC(feature = "character")
featureAttribute's name. (character)
Value of entry. (numeric)
lambdaAS()
Returns entry of 'lambda_as' for user defined attribute. Lambda is a specific optimization parameter that is derived from the arcsine transfromation procedure.
pgu.transformator$lambdaAS(feature = "character")
featureAttribute's name. (character)
Value of entry. (numeric)
featureIdx()
Returns the index of a pgu.normDist object wihtin the instance variable 'trafoParameter'.
pgu.transformator$featureIdx(feature = "character")
featureAttribute's name. (character)
Index of attribute entry in dataframe (numeric)
addConstGenerator()
Calculates and returns the addConst. A constant that prevents the occurrence of negative values as well as zero, if added to an attribute.
pgu.transformator$addConstGenerator(value = "numeric")
valueThe smallest of the attribute's values. (numeric)
The addConst for the attribute (numeric)
mirrorNumeric()
Mirrors the assigned values at the coordinate origin.
pgu.transformator$mirrorNumeric(value = "numeric")
valueValue or vector of values. (numeric)
Value or vector of values. (numeric)
mirrorData()
Calls the class' mirrorNumeric function on all numeric attributes of a data frame.
pgu.transformator$mirrorData(data = "tbl_df")
dataA data frame. (tibble:tibble)
A data frame (tibble::tibble)
calculateAddConst()
Calculates the addConst value for each attribute of the assigned data frame, by calling the class' addConstGenerator function. The results are stored in addConst attribute of the trafoParameter instance variable.
pgu.transformator$calculateAddConst(data = "tbl_df")
dataA data frame. (tibble:tibble)
translateNumeric()
Translates the assigned values by a constant.
pgu.transformator$translateNumeric(value = "numeric", const = "numeric")
valueA numeric or a vector of numerics to be translated. (numeric)
constA constant value. (numeric)
A numeric or a vector of numerics. (numeric)
translateData()
Translates each attribute of the assigned data frame, by calling the class' translateNumeric function. The respective addConst values of the individual attributes of the data frame serve as const variables.
pgu.transformator$translateData(data = "tbl_df")
dataA data frame. (tibble:tibble)
A data frame. (tibble:tibble)
backTranslateNumeric()
Back-translates the assigned values by a constant.
pgu.transformator$backTranslateNumeric(value = "numeric", const = "numeric")
valueA numeric or a vector of numerics to be back-translated. (numeric)
constA constant value. (numeric)
A numeric or a vector of numerics. (numeric)
backTranslateData()
Back-translates each attribute of the assigned data frame, by calling the class' backTranslateNumeric function. The respective addConst values of the individual attributes of the data frame serve as const variables.
pgu.transformator$backTranslateData(data = "tbl_df")
dataA data frame. (tibble:tibble)
A data frame. (tibble:tibble)
lambdaEstimator()
Estimates the lambda factor for the given values, that are assigned to a user defined attribute..
pgu.transformator$lambdaEstimator(value = "numeric", feature = "character")
valueA numeric or a vector of numerics to be analyzed. (numeric)
featureThe attribute which the given values are assigned to. (character)
The specific lambda factor. (numeric)
estimateLambda_temp()
Estimates the lambda factor for each attribute of the assigned data frame, by calling the class' lambdaEstimator function. The respective lambda values of the individual attributes of the data frame are stored in the lambda attribute of the instance variable trafoParameter.
pgu.transformator$estimateLambda_temp(data = "tbl_df")
dataA data frame. (tibble:tibble)
estimateLambda()
Estimates the arcsine transformation lambda factor for each attribute of the assigned data frame. The respective lambda values of the individual attributes of the data frame are stored in the lambda attribute of the instance variable trafoParameter.
pgu.transformator$estimateLambda(data = "tbl_df")
dataA data frame. (tibble:tibble)
normalizeArcSine()
Estimates the lambda factor for an arcsine transformation for the given values,
pgu.transformator$normalizeArcSine(value = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
The specific lambda factor. (numeric)
optimizeTukeyLadderOfPowers()
Estimates the lambda factor for a tukeyLOP transformation for the given values,
pgu.transformator$optimizeTukeyLadderOfPowers(value = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
The specific lambda factor. (numeric)
optimizeBoxCox()
Estimates the lambda factor for a boxcox transformation for the given values,
pgu.transformator$optimizeBoxCox(value = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
The specific lambda factor. (numeric)
transformNumeric()
Transforms the given numeric values, that are assigned to a user defined attribute.
pgu.transformator$transformNumeric(value = "numeric", feature = "character")
valueA numeric or a vector of numerics to be tranformed. (numeric)
featureThe attribute which the given values are assigned to. (character)
A transfromed version of the given numeric or vector of numerics. (numeric)
transformData()
Transforms each attribute of the assigned data frame, by calling the class' tranformNumeric function. The respective lambda values of the individual attributes of the data frame are read from the lambda attribute of the instance variable trafoParameter.
pgu.transformator$transformData(data = "tbl_df")
dataA data frame. (tibble:tibble)
transformLogModulus()
Performes a log transformation for the given values, based on a user defined base value.
pgu.transformator$transformLogModulus(value = "numeric", base = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
baseLogarithmic base. (numeric)
The transformed values. (numeric)
transformSquareRoot()
Performes a square root transformation for the given values.
pgu.transformator$transformSquareRoot(value = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
The transformed values. (numeric)
transformCubeRoot()
Performes a cube root transformation for the given values.
pgu.transformator$transformCubeRoot(value = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
The transformed values. (numeric)
transformArcsine()
Performes an arcsine transformation for the given values.
pgu.transformator$transformArcsine(value = "numeric", lambda = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
lambdaNormalization factor. (numeric)
The transformed values. (numeric)
transformInverse()
Performes an inverse transformation for the given values.
pgu.transformator$transformInverse(value = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
The transformed values. (numeric)
transformTukeyLadderOfPowers()
Performes a tukeyLOP transformation for the given values.
pgu.transformator$transformTukeyLadderOfPowers( value = "numeric", lambda = "numeric" )
valueA numeric or a vector of numerics to be analyzed. (numeric)
lambdaLambda factor. (numeric)
The transformed values. (numeric)
transformBoxCox()
Performes a boxcox transformation for the given values.
pgu.transformator$transformBoxCox(value = "numeric", lambda = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
lambdaLambda factor. (numeric)
The transformed values. (numeric)
inverseTransformNumeric()
Inverse transforms the given numeric values, that are assigned to a user defined attribute.
pgu.transformator$inverseTransformNumeric( value = "numeric", feature = "character" )
valueA numeric or a vector of numerics to be tranformed. (numeric)
featureThe attribute which the given values are assigned to. (character)
An inverse transfromed version of the given numeric or vector of numerics. (numeric)
inverseTransformData()
Inverse transforms each attribute of the assigned data frame, by calling the class' tranformNumeric function. The respective lambda values of the individual attributes of the data frame are read from the lambda attribute of the instance variable trafoParameter.
pgu.transformator$inverseTransformData(data = "tbl_df")
dataA data frame. (tibble:tibble)
inverseTransformLogModulus()
Performes an inverse log transformation for the given values, based on a user defined base value.
pgu.transformator$inverseTransformLogModulus( value = "numeric", base = "numeric" )
valueA numeric or a vector of numerics to be analyzed. (numeric)
baseLogarithmic base. (numeric)
The transformed values. (numeric)
inverseTransformSquareRoot()
Performes an inverse square root transformation for the given values.
pgu.transformator$inverseTransformSquareRoot(value = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
The transformed values. (numeric)
inverseTransformCubeRoot()
Performes an inverse cube root transformation for the given values.
pgu.transformator$inverseTransformCubeRoot(value = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
The transformed values. (numeric)
inverseTransformArcsine()
Performes an inverse arcsine transformation for the given values.
pgu.transformator$inverseTransformArcsine( value = "numeric", lambda = "numeric" )
valueA numeric or a vector of numerics to be analyzed. (numeric)
lambdaNormalization factor. (numeric)
The transformed values. (numeric)
inverseTransformInverse()
Performes an inverse inverse-transformation for the given values.
pgu.transformator$inverseTransformInverse(value = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
The transformed values. (numeric)
inverseTransformTukeyLadderOfPowers()
Performes an inverse tukeyLOP transformation for the given values.
pgu.transformator$inverseTransformTukeyLadderOfPowers( value = "numeric", lambda = "numeric" )
valueA numeric or a vector of numerics to be analyzed. (numeric)
lambdaLambda factor. (numeric)
The transformed values. (numeric)
inverseTransformBoxCox()
Performes an inverse boxcox transformation for the given values.
pgu.transformator$inverseTransformBoxCox(value = "numeric", lambda = "numeric")
valueA numeric or a vector of numerics to be analyzed. (numeric)
lambdaLambda factor. (numeric)
The transformed values. (numeric)
fit()
Estimate all transformation parameters(lambda, addConst,...) for each attribute of a given data frame. The function calls the class' functions calculateAddConst and estimateLambda. The results are stored in the respective attributes of the instance variable trafoParameter.
pgu.transformator$fit(data = "tbl_df")
dataA data frame. (tibble:tibble)
mutateData()
Mutates the values of each attribute of a given data frame. Here, mutation is defined as the cesecutive sequence of the class' functions mirrorData, tranlsateData and transfromData.
pgu.transformator$mutateData(data = "tbl_df")
dataA data frame. (tibble:tibble)
A mutated data frame. (tibble::tibble)
reverseMutateData()
Re-mutates the values of each attribute of a given data frame. Here, re-mutation is defined as the cesecutive sequence of the class' functions inverseTransformData, backTranslateData, mirrorData
pgu.transformator$reverseMutateData(data = "tbl_df")
dataA data frame. (tibble:tibble)
A mutated data frame. (tibble::tibble)
clone()
The objects of this class are cloneable with this method.
pgu.transformator$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Validates that the distribution is not significantly altered by the imputation process. This object is used by the shiny based gui and is not for use in individual R-scripts!
[R6::R6Class] object.
Takes two distributions (before and after imputation). Performs a Wilcoxon-Mann-Whitney U test. Performs a Kolmogorow-Smirnow test.
testStatistics_dfReturns the instance variable 'testStatistics_df'. (tibble::tibble)
centralMoments_orgReturns the instance variable 'centralMoments_org' (tibble::tibble)
centralMoments_impReturns the instance variable 'centralMoments_imp' (tibble::tibble)
centralMoments_deltaReturns the instance variable 'centralMoments_delta' (tibble::tibble)
featuresReturns the instance variable 'features' (character)
seedReturns the instance variable seed (integer)
setSeedSets the instance variable seed. (numeric)
new()
Creates and returns a new 'pgu.validator' object.
pgu.validator$new(seed = 42)
seedSet the instance variable 'seed'. (integer)
A new 'pgu.validator' object. (pguIMP::pgu.validator)
finalize()
Clears the heap and indicates that instance of 'pgu.validator' is removed from heap.
pgu.validator$finalize()
print()
Prints instance variables of a 'pgu.validator' object.
pgu.validator$print()
string
resetValidator()
Resets instance variables
pgu.validator$resetValidator()
kolmogorowTestFeature()
Performs a comparison between the original and the imputated distribution of a given feature using a two-sided Kolmorogow-Smirnow test with simulated p-vaue distribution.
pgu.validator$kolmogorowTestFeature( org = "numeric", imp = "numeric", feature = "character" )
orgOriginal data to be analzed. (numeric)
impImputed data to be analyzed. (numeric)
featureFeature name of the analyzed distributions. (character)
One row dataframe comprising the test results. (tibble::tibble)
wilcoxonTestFeature()
Performs a comparison between the original and the imputated distribution of a given feature using a two-sided Wilcoxon/Mann-Whitney test.
pgu.validator$wilcoxonTestFeature( org = "numeric", imp = "numeric", feature = "character" )
orgOriginal data to be analzed. (numeric)
impImputed data to be analyzed. (numeric)
featureFeature name of the analyzed distributions. (character)
One row dataframe comprising the test results. (tibble::tibble)
centralMomentsFeature()
Estimates estimates the central moments of the given distribution.
pgu.validator$centralMomentsFeature(values = "numeric", feature = "character")
valuesData to be analzed. (numeric)
featureFeature name of the analyzed distributions. (character)
One row dataframe comprising the statistics. (tibble::tibble)
validate()
Validates the feature distributions of the original and the imputated dataframe“ using a two-sided Kolmorogow-Smirnow test and a two-sided Wilcoxon/Mann-Whitney test. The result is stored in the instance variables 'testStatistics_df'and 'distributionStatistics_df'. Displays the progress if shiny is loaded.
pgu.validator$validate( org_df = "tbl_df", imp_df = "tbl_df", progress = "Progress" )
org_dfOriginal dataframe to be analzed. (tibble::tibble)
imp_dfImputed dataframe to be analyzed. (tibble::tibble)
progressIf shiny is loaded, the analysis' progress is stored in this instance of the shiny Progress class. (shiny::Progress)
featurePdf()
Receives a dataframe and plots the pareto density of the features 'org_pdf' and 'imp_pdf'. Returns the plot
pgu.validator$featurePdf(data_df = "tbl_df")
data_dfdataframe to be plotted (tibble::tibble)
A ggplot2 object (ggplot2::ggplot)
featureCdf()
Receives a dataframe and plost the feature 'x' against the features 'org_cdf' and 'imp_cdf'. Returns the plot
pgu.validator$featureCdf(data_df = "tbl_df")
data_dfdataframe to be plotted (tibble::tibble)
A ggplot2 object (ggplot2::ggplot)
featureVs()
Receives two numeric vectors 'org' and 'imp'. Plots the qq-plot of both vectors. Returns the plot
pgu.validator$featureVs(org = "numeric", imp = "numeric")
orgNumric vector comprising the original data. (numeric)
impNumeric vector comprising the imputed data. (numeric)
A ggplot2 object (ggplot2::ggplot)
featureBoxPlot()
Receives a dataframe and information about the lloq and uloq and retuns a boxplot
pgu.validator$featureBoxPlot( data_df = "tbl_df", lloq = "numeric", uloq = "numeric", feature = "character" )
data_dfDataframe to be analyzed (tibble::tibble)
lloqlower limit of quantification (numeric)
uloqupper limit of quantification (numeric)
featureFeature name (character)
A ggplot2 object (ggplot2::ggplot)
featurePlot()
Receives two numeric dataframes 'org_df' and 'imp_df', and a feature name. Creates a compund plot of the validation results for the given feature.. Returns the plot
pgu.validator$featurePlot( org_df = "tbl_df", imp_df = "tbl_df", lloq = "numeric", uloq = "numeric", impIdx_df = "tbl_df", feature = "character" )
org_dfDataframe comprising the original data. (tibble::tibble)
imp_dfDataframe comprising the imputed data. (tibble::tibble)
lloqlower limit of quantification (numeric)
uloqupper limit of quantification (numeric)
impIdx_dfdataframe comprising information about imputation sites (tibble::tibble)
featureFeature name. (character)
A ggplot2 object (ggplot2::ggplot)
clone()
The objects of this class are cloneable with this method.
pgu.validator$clone(deep = FALSE)
deepWhether to make a deep clone.
Sebastian Malkusch
Reproducible cleaning of biomedical laboratory data using methods of visualization, error correction and transformation implemented as interactive R-notebooks.
pguIMP()pguIMP()
A graphical data preprocessing toolbox, named “pguIMP”, that includes a fixed sequence of preprocessing steps to enable error-free data preprocessing interactively. By implementing contemporary data processing methods including machine learning-based imputation procedures, the creation of corrected and cleaned bioanalytical datasets is ensured, which preserve data structures such as clusters better than resulting with classical methods.
shiny application object
Sebastian Malkusch
Calculates bbmle snmor function.
sLogLikelihood(mu = "numeric", sigma = "numeric")sLogLikelihood(mu = "numeric", sigma = "numeric")
mu |
The expextation value. (numeric) |
sigma |
The standard deviation. (numeric) |
the bbmle::snorm results.
Sebastian Malkusch
y <- sLogLikelihood (mu=0.0, sigma=1.0)y <- sLogLikelihood (mu=0.0, sigma=1.0)
Transposes a tibble This object is used by the shiny based gui and is not for use in individual R-scripts!
transposeTibble(obj = "tbl_df")transposeTibble(obj = "tbl_df")
obj |
The data frame to be transposed. (numeric) |
The transposed data frame. (tibble:tibble)
Sebastian Malkusch