# cleanerR package

## The cleanerR Package

Often we are faced with data that has missing values,it is often discussed how to handle this missing data, if we can ignore the rows they appear or if we must find a way to correctly fill the data.

When talking about databases we can define a functional dependency that tells the following:

Given a set of attributes $${P_1,P_2...,P_n}$$ if one can determine a attribute $$P_k$$ value with full certainty by knowing $$P_{j_i}$$ attribute values then we can say the set $$P_{j_i}$$ is a functional dependency to $$P_k$$

We could then define a almost functional dependency by saying that while a set $$P_{j_i}$$ can not fully determine $$P_k$$ it can determine a percentage $$\alpha$$ of it and give a probability distribution for $$1-\alpha$$ of these values.

This package then has the purpose to implement this concept, in which it takes a dataframe, the goal collumn you wish to fill missing data and fills the data with a accuracy given the collumns you choose to use for the almost functional dependency calculation, the following functions can be used as well as examples of how to use them:

Observation: Every function presented has a implementation that can receive a data.table instead of a dataframe. The user does not have to worry to learn its syntax since the system itself wil check if the object is a data table or data frame Then call the corresponding function.

data.tables are recommended when your dataset starts to grow large. ## Functions and Examples

GenerateCandidates

This function takes as a input the dataframe, the goal collumn,The maximum lenght of the set $$P_{j_i}$$ you wish to test(the bigger the longer this calculation will take), a measure of error(the higher the number the higher error you accept), and a trigger variable, the last one works as following:

When you pair all pair of tuples {set,goal} where set is the set of vectors to predict goal some elements may only show once in your dataset, the trigger variable considers that the ratio of these tuples to all possible tuples is defined by $$R_t$$

If $$1-R_t$$ is bigger than the trigger variable we shall reject this set to predict goal as a possible candidate

trigger=1 usually works better when the ratio of $$\frac{length(unique(a))}{length(a)}$$ is smaller.

As trigger draws closer to 0 the best solution may draw closer to a primary key of the dataset

Consider the following example of how to use it

require(plyr)
require(cleanerR)
z=GenerateCandidates(df=iris,goal=5,maxi=3,repetitions=100,trigger=0.0)
#> [1] 1
#> [1] 2
#> [1] 3
print(z[[1]])
#> [[1]]
#> [1] 1 2 3
#>
#> [[2]]
#> [1] 1 2 4
#>
#> [[3]]
#> [1] 1 3 4
#>
#> [[4]]
#> [1] 2 3 4
#>
#> [[5]]
#> [1] 1 3
#>
#> [[6]]
#> [1] 3 4
#>
#> [[7]]
#> [1] 2 3
#>
#> [[8]]
#> [1] 2 4
#>
#> [[9]]
#> [1] 1 4
#>
#> [[10]]
#> [1] 3
#>
#> [[11]]
#> [1] 4
#>
#> [[12]]
#> [1] 1 2
#>
#> [[13]]
#> [1] 2
#>
#> [[14]]
#> [1] 1
cat("error rate\n")
#> error rate
print(z[[2]])
#>  [1]  0  0  0  0  1  1  2  3  4  5  5 10 20 22

Then z is a list of lists where z[[1]] are the candidates and z[[2]] is the error rate,you could call z[[1]] by z$$sets and z[[2]] by z$$error, notice how z is ordered, lets talk about the next function

BestVector:

This function runs generate_candidates and picks the z[[1]] value that has the minimum error rate when you desire the highest possible accuracy,if that is what you desire choose this function, if there are a set of values that are more important to be right than others one can look at other results of generate_candidates

The function can be run as:

BestVector(df=iris,goal=5,maxi=3,repetitions=nrow(iris),trigger=0.8,ratio=0.99)

The attributes are as following

df: dataframe or data.table to use. goal: goal collumn to predict maxi: max number of combinations of sets that will be tested repetitions: Number of alternate possible values, the higher the higher error trigger: In a combination a percentage of tuples would appear only once on the dataset, if a set has 1-p where p is this percentage, then this set is rejected, trigger=0 would allow a trivial solution which is the best set is a primary key. ratio: If a collumn has $$f=\frac{U(x)}{x}$$ where x is the length all its values and $$U(x)$$ is the length of its unique values where $$f>ratio$$ then this set is rejected, $$ratio=1$$ accepts primary keys of the dataset

NA_VALUES

Returns how many NA values the dataframe has in each collumn

It is used by giving the function the dataframe

For example

require(plyr)
require(cleanerR)
NA_VALUES(iris)
#> Sepal.Length  Sepal.Width Petal.Length  Petal.Width      Species
#>            0            0            0            0            0

CompleteDataset

This is the main function of the package, it takes as a input the dataframe, the set of attributes you wish to use as the approximate functional dependency and the attribute you wish to fill

If what you want is highest accuracy possible i would suggest you run the following in sequence

a=BestVector(df=df,goal=missing,….)

new_df=CompleteDataset(df=df,rows=a,goal=missing)

Then new_df is equal to df but the goal collumn has no missing values or very close to none in special cases where all ocurrences of a certain value disappeared in the original dataset so the system wont try to guess in this case

Of course if you want to complete your dataset you want to know what is the actual accuracy you are getting to fill this data to know if you can trust on the information you get on the new dataframe, to do so i give you the following functions:

MeanAccuracy:

This function consider the hypothesis that the data you have is representative of the missing values, then it computes the expected accuracy you get (a number between 0 and 1) when filling the data by this hypothesis, to run it you use:

MeanAccuracy(df=df,VECTORS=a,goal=missing)

Where a is the set of attributes you are using to predict missing.

BestAccuracy

This function works like the above but the hypothesis is all missing values are related to the attribute you have the highest confidence when predicting, the way to use is the same.

WorstAccuracy:

This function works like the above but the hypothesis is all missing values are related to the attribute you have the lowest confidence when predicting, the way to use is the same.