updating documentation

Author: edwindj

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: errorlocate
 Type: Package
 Title: Locate Errors with Validation Rules
-Version: 1.1.1
+Version: 1.1.2
 Authors@R: c(person("Edwin", "de Jonge", email = "[email protected]", role = c("aut", "cre"), comment=c(ORCID="0000-0002-6580-4718")),
              person("Mark", "van der Loo", email = "[email protected]", role = c("aut")))
 Description: Errors in data can be located and removed using validation rules from package 
@@ -21,7 +21,7 @@ Suggests:
     covr,
     knitr,
     rmarkdown
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Encoding: UTF-8
 Collate: 
     'MipRules.R'

NAMESPACE

@@ -1,6 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(as.character,dnf)
+S3method(as.character,mip_rule)
 S3method(as.data.frame,errorlocation)
 S3method(as.expression,dnf)
 S3method(print,dnf)

R/MipRules.R

@@ -1,6 +1,6 @@
 #' Create a mip object from a validator object
 #'
-#' Create a mip object from [validator()] object.
+#' Create a mip object from [validate::validator()] object.
 #' This is a utility class that translates a validor object into a mixed integer problem that
 #' can be solved.
 #' Most users should use [locate_errors()] which will handle all translation and execution

R/errorlocalizer.R

@@ -21,15 +21,15 @@ setRefClass("ErrorLocalizer",
   )
 )
 
-#' Feligi-Holt Errorlocalizer
+#' Fellegi-Holt Errorlocalizer
 #'
-#' Implementation of the Feligi-Holt algorithm using the `ErrorLocalizer` base class.
-#' Given a set of validation rules and a dataset the Feligi-Holt algorithm finds for each record
+#' Implementation of the Fellegi-Holt algorithm using the `ErrorLocalizer` base class.
+#' Given a set of validation rules and a dataset the Fellegi-Holt algorithm finds for each record
 #' the smallest (weighted) combination of variables that are erroneous (if any).
 #'
 #' @note Most users do not need this class and can use [locate_errors()].
 #'
-#' `errorlocalizer` implements feligi holt using a MIP-solver. For problems in which
+#' `errorlocalizer` implements Fellegi holt using a MIP-solver. For problems in which
 #' coefficients of the validation rules or the data are too different, you should consider scaling
 #' the data.
 #' @include MipRules.R

R/errorlocate-package.r

@@ -3,7 +3,7 @@
 #' Find errors in data given a set of validation rules.
 #' The `errorlocate` helps to identify obvious errors in raw datasets.
 #'
-#' It works in tandem with the package [validate()].
+#' It works in tandem with the package `validate`.
 #' With `validate` you formulate data validation rules to which the data must comply.
 #' For example:
 #'

R/errorlocation.R

@@ -12,11 +12,11 @@
 #'
 #'
 #' Current implementation assumes that errors are record based. The error locations can be retrieved
-#' using the method [values()] and are a matrix of
+#' using the method [validate::values()] and are a matrix of
 #' rows and columns, with the same dimensions are the `data.frame` that was checked.
 #' For errors that are purely column based, or dataset based, errorlocations will return a matrix with all
 #' rows or cells set to `TRUE`.
-#' The [values()] return `NA` for missing values.
+#' The [validate::values()] return `NA` for missing values.
 
 #' @section Fields:
 #'

R/linear.R

@@ -10,7 +10,7 @@ LOGS <- c("log", "log1p", "log10", "log2")
 #' categorical and conditional rules to be used in finding errors. Other rule types
 #' are ignored during error finding.
 #' @export
-#' @param x [validator()] object containing data validation rules
+#' @param x [validate::validator()] object containing data validation rules
 #' @param ... not used
 #' @return `logical` indicating which rules are (purely) linear.
  #' @family rule type

R/locate-errors.R

@@ -2,7 +2,8 @@
 #'
 #' Find out which fields in a data.frame are "faulty" using validation rules
 #' This method returns found errors, according to the specified method `x`.
-#' Use method [replace_errors()], to automatically remove these errors.
+#' Use method [replace_errors()], to automatically remove these errors. Use
+#' `[base::set.seed()]` beforehand to make the function call reproducible.
 #' `
 #'
 #' Use an `Inf` `weight` specification to fixate variables that can not be changed.

R/mip_lpsolve.R

@@ -6,7 +6,7 @@
 #' @param  rules mip rules
 #' @param objective function
 #' @param eps accuracy for equality/inequality
-#' @param ... additional [lp.control()] parameters that are set for the mip problem
+#' @param ... additional [lpSolveAPI::lp.control()] parameters that are set for the mip problem
 translate_mip_lp <- function( rules
                             , objective=NULL
                             , eps = 1e-3

R/mip_rule.R

@@ -18,6 +18,7 @@ mip_rule <- function(a, op, b, rule, type, weight=Inf, ...){
            )
 }
 
+#' @export
 as.character.mip_rule <- function(x, ...){
   a <- paste0(x$a, "*", names(x$a), collapse= ' + ')
 
@@ -29,6 +30,7 @@ as.character.mip_rule <- function(x, ...){
   paste0(a, " ",x$op, " ", x$b, sep = "")
 }
 
+#' @export
 print.mip_rule <- function(x, ...){
   a <- paste0(x$a, "*", names(x$a), collapse= ' + ')