editrules: Parsing, Applying, and Manipulating Data Cleaning Rules
Version 2.9.0

Facilitates reading and manipulating (multivariate) data restrictions (edit rules) on numerical and categorical data. Rules can be defined with common R syntax and parsed to an internal (matrix-like format). Rules can be manipulated with variable elimination and value substitution methods, allowing for feasibility checks and more. Data can be tested against the rules and erroneous fields can be found based on Fellegi and Holt's generalized principle. Rules dependencies can be visualized with using the igraph package.

Browse man pages Browse package API and functions Browse package files

AuthorEdwin de Jonge, Mark van der Loo
Date of publication2015-06-11 11:16:28
MaintainerEdwin de Jonge <edwindjonge@gmail.com>
LicenseGPL-3
Version2.9.0
URL https://github.com/data-cleaning/editrules
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("editrules")

Man pages

adddummies: Add dummy variable to the data.frames, these are needed for...
adjacency: Derive adjecency matrix from collection of edits
as.character.cateditmatrix: Coerce an cateditmatrix to a 'character' vector
as.editmatrix: Coerce a matrix to an edit matrix.
as.editset: Coerce x to an editset
asLevels: Transform a found solution into a categorical record
as.lp.mip: Coerces a 'mip' object into an lpsolve object
as.mip: Write an editset into a mip representation
backtracker: Backtracker: a flexible and generic binary search program
blocks: Decompose a matrix or edits into independent blocks
cateditmatrix: Create an editmatrix with categorical variables
checkDatamodel: Check data against a datamodel
condition: Get condition matrix from an editset.
contains: Determine which edits contain which variable(s)
contains.boolmat: Determine if a boolean matrix contains 'var'
datamodel: Summarize data model of an editarray in a data.frame
disjunct: Decouple a set of conditional edits
duplicated.editarray: Check for duplicate edit rules
duplicated.editmatrix: Check for duplicate edit rules
echelon: Bring an (edit) matrix to reduced row echelon form.
editarray: convert to matrix
editfile: Read edits edits from free-form textfile
editmatrix: convert to matrix
editnames: Names of edits
editrules-package: An overview of the function of package 'editrules'
editrules.plotting: Graphical representation of edits
edits: Example editrules, used in vignette
editset: Read general edits
editType: Determine edittypes in editset based on 'contains(E)'
eliminate: Eliminate a variable from a set of edit rules
errorLocalizer: Create a backtracker object for error localization
errorLocalizer_mip: Localize errors using a MIP approach.
errorLocation: The errorLocation object
expandEdits: Expand an edit expression
fcf.env: Field code forest algorithm
generateEdits: Derive all essentially new implicit edits
getA: Returns the coefficient matrix 'A' of linear (in)equalities
getAb: Returns augmented matrix representation of edit set.
getArr: Get named logical array from editarray
getb: Returns the constant part 'b' of a linear (in)equality
geth: Returns the derivation history of an edit matrix or array
getInd: get index list from editmatrix
getlevels: retrieve level names from editarray
getnames: retrieve edit names from editarray
getOps: Returns the operator part of a linear (in)equality...
getSep: get seprator used to seperate variables from levels in...
getUpperBounds: Get upperbounds of edits, given the boundaries of all...
getVars: get names of variables in a set of edits
getVars.cateditmatrix: Returns the variable names of an (in)equality 'editmatrix' E
getVars.editarray: get variable names in editarray
getVars.editlist: get variable names
getVars.editmatrix: Returns the variable names of an (in)equality 'editmatrix' E
impliedValues: Retrieve values stricktly implied by rules
ind2char: Derive textual representation from (partial) indices
indFromArray: Compute index from array part of editarray
is.editrules: Check object class
isFeasible: Check consistency of set of edits
isNormalized: Check if an editmatrix is normalized
isObviouslyInfeasible: Check for obvious contradictions in a set of edits
isObviouslyRedundant: Find obvious redundancies in set of edits
isSubset: Check which edits are dominated by other ones.
localize: Workhorse function for localizeErrors
localizeErrors: Localize errors on records in a data.frame.
nedits: Number of edits Count the number of edits in a collection of...
neweditarray: editarray: logical array where every column corresponds to...
neweditmatrix: Create an 'editmatrix' object from its constituing...
newerrorlocation: Generate new errorlocation object
normalize: Normalizes an editmatrix
parseCat: Parse a categorical edit expression
parseCatEdit: parse categorial edit
parseEdits: Parse a character vector of edits
parseMix: Parse a mixed edit
parseNum: Parse a numerical edit expression
print.backtracker: print a backtracker
print.cateditmatrix: print cateditmatrix
print.editarray: print editarray
print.editlist: print editset
print.editmatrix: print editmatrix
print.editset: print editset
print.editsummary: summary
print.errorLocation: Print object of class errorLocation
print.locationsummary: summary
print.violatedEdits: Print violatedEdits
reduce: Remove redundant variables and edits.
removeRedundantDummies: Remove redundant dummy variables
separate: Separate an editset into its disconnected blocks and simplify
simplify: Simplify logical mixed edits in an editset
softEdits: Derive editmatrix with soft constraints based on boundaries...
softEdits.cateditmatrix: Derive editmatrix with soft constraints. This is a utility...
softEdits.editarray: Derive editmatrix with soft constraints based on boundaries...
softEdits.editmatrix: Derive editmatrix with soft constraints based on boundaries...
subsetting: Row index operator for 'editmatrix'
substValue: Replace a variable by a value in a set of edits.
violatedEdits: Check data against constraints
writeELAsMip: Rewrite an editset and reported values into the components...

Functions

[.cateditmatrix Man page
[.editarray Man page
[.editlist Man page
[.editmatrix Man page
[.editset Man page
adddummies Man page Source code
adjacency Man page Source code
adjacency.editarray Man page Source code
adjacency.editmatrix Man page Source code
adjacency.editset Man page Source code
adjec Source code
as.character.cateditmatrix Man page Source code
as.character.editarray Man page Source code
as.character.editmatrix Man page Source code
as.character.editset Man page Source code
as.data.frame.editarray Man page Source code
as.data.frame.editmatrix Man page Source code
as.data.frame.editset Man page Source code
as.data.frame.violatedEdits Man page Source code
as.editmatrix Man page Source code
as.editset Man page Source code
as.expression.editarray Man page Source code
as.expression.editmatrix Man page Source code
as.igraph.editarray Man page Source code
as.igraph.editmatrix Man page Source code
as.igraph.editset Man page Source code
as.lp.mip Man page Source code
as.matrix.editarray Man page Source code
as.matrix.editmatrix Man page Source code
as.mip Man page Source code
asCat Source code
asLevels Man page Source code
asSOS Source code
backtracker Man page Source code
blockIndex Man page Source code
blocks Man page Source code
c.editarray Man page Source code
c.editmatrix Man page Source code
c.editset Man page Source code
cateditmatrix Man page Source code
checkDatamodel Man page Source code
checkDatamodel.editarray Source code
checkDatamodel.editmatrix Source code
checkDatamodel.editset Source code
checkRows Source code
checkRows.character Source code
checkRows.data.frame Source code
checkRows.editmatrix Source code
choicepoint Man page Source code
condition Man page Source code
contains Man page Source code
contains.boolmat Man page Source code
contains.cateditmatrix Man page Source code
contains.editarray Man page Source code
contains.editmatrix Man page Source code
contains.editset Man page Source code
contains.matrix Man page Source code
datamodel Man page Source code
disjunct Man page Source code
dnf Source code
duplicated.editarray Man page Source code
duplicated.editmatrix Man page Source code
echelon Man page Source code
echelon.editmatrix Man page Source code
echelon.editset Man page Source code
echelon.matrix Man page Source code
editType Man page Source code
editTypes Source code
editarray Man page Source code
editfile Man page Source code
editmatrix Man page Source code
editnames Man page Source code
editrules-package Man page
editrules.plotting Man page
edits Man page
editset Man page Source code
eliminate Man page Source code
eliminate.editarray Man page Source code
eliminate.editlist Man page Source code
eliminate.editmatrix Man page Source code
eliminate.editset Man page Source code
emptyStatus Source code
emptyerrorlocation Source code
errorLocalizer Man page Source code
errorLocalizer.editarray Man page Source code
errorLocalizer.editlist Man page Source code
errorLocalizer.editmatrix Man page Source code
errorLocalizer.editset Man page Source code
errorLocalizer_mip Man page Source code
errorLocation Man page
expandEdits Man page Source code
fcf.env Man page Source code
generateEdits Man page Source code
getA Man page Source code
getAb Man page Source code
getArr Man page Source code
getDuration Source code
getH Man page Source code
getInd Man page Source code
getOps Man page Source code
getSep Man page Source code
getUpperBounds Man page Source code
getVars Man page Source code
getVars.NULL Man page Source code
getVars.cateditmatrix Man page Source code
getVars.editarray Man page Source code
getVars.editlist Man page Source code
getVars.editmatrix Man page Source code
getVars.editset Man page Source code
getb Man page Source code
geth Man page Source code
getlevels Man page Source code
getnames Man page Source code
hasNum Source code
impliedValues Man page Source code
impliedValues.editmatrix Man page Source code
ind2char Man page Source code
indFromArray Man page Source code
invert Source code
is.cateditmatrix Source code
is.editarray Man page Source code
is.editmatrix Man page Source code
is.editrules Man page
is.editset Man page Source code
isCat Source code
isContradiction Source code
isFeasible Man page Source code
isNormalized Man page Source code
isNum Source code
isObviouslyInfeasible Man page Source code
isObviouslyInfeasible.NULL Source code
isObviouslyInfeasible.editarray Man page Source code
isObviouslyInfeasible.editenv Man page Source code
isObviouslyInfeasible.editlist Man page Source code
isObviouslyInfeasible.editmatrix Man page Source code
isObviouslyInfeasible.editset Man page Source code
isObviouslyRedundant Man page Source code
isObviouslyRedundant.editarray Man page Source code
isObviouslyRedundant.editenv Man page Source code
isObviouslyRedundant.editlist Man page Source code
isObviouslyRedundant.editmatrix Man page Source code
isObviouslyRedundant.editset Man page Source code
isObviouslyRedundant.matrix Source code
isRedundant.boolmat Source code
isSubset Man page Source code
isSubset.boolmat Source code
isSubsetWrt.boolmat Source code
isTautology Source code
listViolatedEdits Source code
localize Man page Source code
localizeErrors Man page Source code
localize_singleton Source code
nedits Man page Source code
negateEdit Source code
neweditarray Man page Source code
neweditmatrix Man page Source code
neweditset Source code
newerrorlocation Man page Source code
newviolatedEdits Source code
normalize Man page Source code
onAttach Source code
parseCat Man page Source code
parseCatEdit Man page Source code
parseEdits Man page Source code
parseMix Man page Source code
parseNum Man page Source code
parseTree Source code
perturbWeights Source code
plot.editarray Man page Source code
plot.editmatrix Man page Source code
plot.editset Man page Source code
plot.errorLocation Man page Source code
plot.violatedEdits Man page Source code
plotEditGraph Source code
print.backtracker Man page Source code
print.cateditmatrix Man page Source code
print.editarray Man page Source code
print.editlist Man page Source code
print.editmatrix Man page Source code
print.editset Man page Source code
print.editsummary Man page Source code
print.errorLocation Man page Source code
print.locationsummary Man page Source code
print.mip Source code
print.violatedEdits Man page Source code
reduce Man page Source code
reduce.editarray Man page Source code
reduce.editmatrix Man page Source code
reduce.editset Man page Source code
removeRedundant Source code
removeRedundantDummies Man page Source code
resolves Source code
retrieveCoef Source code
rewriteInEq Source code
scale_fac Source code
secToHuman Source code
separate Man page Source code
simplify Man page Source code
softEdits Man page Source code
softEdits.cateditmatrix Man page Source code
softEdits.editarray Man page Source code
softEdits.editmatrix Man page Source code
str.editarray Source code
str.editmatrix Man page Source code
substValue Man page Source code
substValue.editarray Man page Source code
substValue.editenv Man page Source code
substValue.editlist Man page Source code
substValue.editmatrix Man page Source code
substValue.editset Man page Source code
summary.editarray Man page Source code
summary.editmatrix Man page Source code
summary.editset Man page Source code
summary.errorLocation Man page Source code
summary.violatedEdits Man page Source code
toCat Source code
toDataFrame Source code
varTypeAndOccurrence Source code
violatedEdits Man page Source code
violatedEdits.character Man page Source code
violatedEdits.data.frame Source code
violatedEdits.editarray Man page Source code
violatedEdits.editmatrix Man page Source code
violatedEdits.editset Man page Source code
writeELAsMip Man page Source code

Files

inst
inst/script
inst/script/edits
inst/script/edits/mixedits.R
inst/script/edits/myedits.txt
inst/script/bench
inst/script/bench/benchmip_mixed.R
inst/script/bench/randomEdits.R
inst/script/bench/edits.R
inst/script/bench/benchmip_categorical.R
inst/script/bench/benchAB.R
inst/script/bench/benchMIP.R
inst/script/bench/eliminator.R
inst/script/bench/benchmip_mixed2.R
inst/script/bench/benchmip_balance.R
inst/doc
inst/doc/index.html
inst/doc/DeJongeVanderLoo2011-2.pdf
inst/doc/DeJongeVanderLoo2011.pdf
inst/doc/editrules-vignette.Rnw
inst/doc/editrules-vignette.pdf
tests
tests/test_all.R
tests/testthat
tests/testthat/testeditmatrix.R
tests/testthat/testlocalizeErrors_mip.R
tests/testthat/testCheckDatamodel.R
tests/testthat/testViolatedEdits.R
tests/testthat/testFourierMotzkin.R
tests/testthat/testSubstValue.R
tests/testthat/testeditmatrixAttr.R
tests/testthat/edit_test_1.txt
tests/testthat/testParseEdits.R
tests/testthat/testIsFeasible.R
tests/testthat/testIsObviouslyRedundant.R
tests/testthat/testCheck.R
tests/testthat/testechelon.R
tests/testthat/testgetVars.R
tests/testthat/testdatamodel.R
tests/testthat/testIsObviouslyInfeasible.R
tests/testthat/testErrorLocalizer.R
tests/testthat/testEditset.R
tests/testthat/testeditarray.R
tests/testthat/testDuplicated.R
tests/testthat/testBlocks.R
tests/testthat/testc.R
tests/testthat/testContains.R
tests/testthat/testEditRow.R
tests/testthat/testLocalizeErrors.R
NAMESPACE
NEWS
data
data/edits.RData
R
R/editrules-data.R
R/list2env.R
R/echelon.R
R/violatedEdits.R
R/isSubset.R
R/parseMix.R
R/subsetting.R
R/cateditmatrix.R
R/duplicated.R
R/errorLocation.R
R/editmatrixAttr.R
R/perturbWeights.R
R/mip.R
R/eliminate.R
R/plot.R
R/pkg.R
R/reduce.R
R/as.matrix.R
R/c.R
R/editset.R
R/isObviouslyRedundant.R
R/contains.R
R/editmatrix.R
R/disjunct.R
R/editAttr.R
R/getH.R
R/softEdits.R
R/parseNum.R
R/removeRedundant.R
R/plot_errorLocation.R
R/editfile.R
R/is.R
R/checkRows.R
R/print.R
R/localizeErrors.R
R/getUpperBounds.R
R/as.igraph.R
R/getVars.R
R/expandEdits.R
R/editarrayAttr.R
R/isObviouslyInfeasible.R
R/parseCat.R
R/checkDatamodel.R
R/backtracker.R
R/summary.R
R/str.R
R/errorLocalizer_mip.R
R/blocks.R
R/isFeasible.R
R/writeELAsMip.R
R/errorLocalizer.R
R/zzz.R
R/substValue.R
R/parseEdits.R
R/adjacency.R
R/editarray.R
R/generateEdits.R
vignettes
vignettes/editrules-vignette.Rnw
MD5
build
build/vignette.rds
DESCRIPTION
man
man/getSep.Rd
man/editfile.Rd
man/substValue.Rd
man/as.character.cateditmatrix.Rd
man/adjacency.Rd
man/isFeasible.Rd
man/adddummies.Rd
man/isObviouslyInfeasible.Rd
man/editnames.Rd
man/impliedValues.Rd
man/as.editset.Rd
man/getVars.Rd
man/neweditarray.Rd
man/subsetting.Rd
man/editmatrix.Rd
man/nedits.Rd
man/cateditmatrix.Rd
man/expandEdits.Rd
man/print.violatedEdits.Rd
man/as.editmatrix.Rd
man/errorLocalizer.Rd
man/removeRedundantDummies.Rd
man/parseEdits.Rd
man/parseNum.Rd
man/errorLocalizer_mip.Rd
man/errorLocation.Rd
man/is.editrules.Rd
man/edits.Rd
man/parseCat.Rd
man/getInd.Rd
man/datamodel.Rd
man/editrules-package.Rd
man/parseCatEdit.Rd
man/print.editmatrix.Rd
man/localize.Rd
man/newerrorlocation.Rd
man/softEdits.editmatrix.Rd
man/fcf.env.Rd
man/isNormalized.Rd
man/as.lp.mip.Rd
man/softEdits.Rd
man/asLevels.Rd
man/localizeErrors.Rd
man/print.locationsummary.Rd
man/getArr.Rd
man/print.backtracker.Rd
man/violatedEdits.Rd
man/separate.Rd
man/disjunct.Rd
man/getVars.cateditmatrix.Rd
man/parseMix.Rd
man/indFromArray.Rd
man/getA.Rd
man/generateEdits.Rd
man/editrules.plotting.Rd
man/checkDatamodel.Rd
man/editarray.Rd
man/getOps.Rd
man/ind2char.Rd
man/writeELAsMip.Rd
man/neweditmatrix.Rd
man/contains.boolmat.Rd
man/softEdits.cateditmatrix.Rd
man/softEdits.editarray.Rd
man/geth.Rd
man/getVars.editmatrix.Rd
man/eliminate.Rd
man/getVars.editlist.Rd
man/editset.Rd
man/editType.Rd
man/blocks.Rd
man/print.editsummary.Rd
man/getnames.Rd
man/print.editset.Rd
man/normalize.Rd
man/simplify.Rd
man/contains.Rd
man/print.errorLocation.Rd
man/reduce.Rd
man/getlevels.Rd
man/print.editlist.Rd
man/duplicated.editarray.Rd
man/duplicated.editmatrix.Rd
man/getAb.Rd
man/condition.Rd
man/as.mip.Rd
man/getUpperBounds.Rd
man/getb.Rd
man/isSubset.Rd
man/echelon.Rd
man/backtracker.Rd
man/getVars.editarray.Rd
man/print.cateditmatrix.Rd
man/isObviouslyRedundant.Rd
man/print.editarray.Rd
editrules documentation built on May 20, 2017, 3:18 a.m.