Add ignore.case param. to + op; closes #47

Author: mwmclean

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: RefManageR
-Version: 1.1.0
+Version: 1.2.0
 Title: Straightforward 'BibTeX' and 'BibLaTeX' Bibliography Management
 Authors@R: person(c("Mathew", "W."), "McLean", role = c("aut", "cre"),
     email = "[email protected]")

R/BibEntryAddOp.R

@@ -13,6 +13,8 @@
 #' is a duplicate?  Can include \code{"bibtype"} to check entry type and
 #' \code{"key"} to check entry keys. Specifying \code{"all"} checks all fields
 #' using \code{\link{duplicated}}.
+#' @param ignore.case logical; if \code{TRUE}, case is ignored when determining
+#' if fields are duplicates.
 #' @return an object of class BibEntry
 #' @family operators
 #' @seealso \code{\link{duplicated}}, \code{\link{unique}}
@@ -27,7 +29,7 @@
 #' bib2 <- bib[45:length(bib)]
 #'
 #' ## The following is FALSE because the parent entry of one entry in bib1
-#' ##   is in bib2, so the child entry in is expanded in the BibEntry object
+#' ##   is in bib2, so the child entry is expanded in the BibEntry object
 #' ##   returned by `[` to include the fields inherited from the dropped parent
 #' identical(merge(bib1, bib2, 'all'), bib)
 #' toBiblatex(bib1[[1L]])
@@ -54,6 +56,7 @@
 #' @keywords methods
 `+.BibEntry` <- function(e1, e2){
   fields.to.check <- .BibOptions$merge.fields.to.check
+  ignore.case <- .BibOptions$ignore.case
   awl <- "all" %in% fields.to.check
   att1 <- attributes(e1)[bibentry_list_attribute_names]
   att2 <- attributes(e2)[bibentry_list_attribute_names]
@@ -81,17 +84,26 @@
       possible.dup <- unlist(e2$bibtype) %in% unlist(e1$bibtype)
     }
     remain.dup.f <- setdiff(fields.to.check, c('bibtype', 'key'))
-    
+
     if (length(dup.ind <- possible.dup) && length(remain.dup.f)){
+      ty <- unclass(e1)
+      ty <- lapply(ty, function(y, f, ignore.case){
+          y <- y[f]
+          if (ignore.case)
+              y <- lapply(y, tolower)
+          y
+      }, f = remain.dup.f, ignore.case = ignore.case)
       dup.ind <- vapply(unclass(e2[possible.dup]),
-                      function(x, y, flds){
+                      function(x, y, flds, ignore.case){
                         x <- x[flds]
+                        if (ignore.case)
+                          x <- lapply(x, tolower)
                         for (i in seq_along(y)){
-                          if (identical(y[[i]][flds], x))
+                          if (identical(y[[i]], x))
                             return(TRUE)
                         }
                         return(FALSE)
-                    }, FALSE, y = unclass(e1), flds = remain.dup.f)
+                    }, FALSE, y = ty, flds = remain.dup.f, ignore.case = ignore.case)
       if (length(dup.ind))
           dup.ind <- which(dup.ind)
     }
@@ -128,8 +140,10 @@
 #' @rdname merge.BibEntry
 merge.BibEntry <- function(x, y,
                            fields.to.check = BibOptions()$merge.fields.to.check,
+                           ignore.case = BibOptions()$ignore.case,
                            ...){
-  oldfields <- BibOptions(merge.fields.to.check = fields.to.check)
+  oldfields <- BibOptions(merge.fields.to.check = fields.to.check,
+                            ignore.case = ignore.case)
   on.exit(BibOptions(oldfields))
   `+.BibEntry`(x, y)
 }

inst/NEWS.md

@@ -1,3 +1,11 @@
+Changes in Version 1.2.0 (2018-04-24)
+--------------------------------------------------------
+
+* `+.BibEntry` and `merge.BibEntry` gain an argument ignore.case,
+which defaults to `BibOptions()$ignore.case` (`TRUE`) so that case is 
+ignore when checking for duplicate fields (h/t Justin Calabrese #47)
+
+
 Changes in Version 1.1.0 (2018-04-02)
 --------------------------------------------------------
 

tests/testthat/test-methods.R

@@ -51,6 +51,18 @@ test_that("merge function, two fields to check", {
     expect_equal(length(res), 6L)
 })
 
+test_that("addition operator ignore.case",
+{
+    bib1 <- BibEntry(key = "k1", title = "THE TITLE", author = "Smith, John",
+                     bibtype = "Misc", year = 2018)
+    bib2 <- BibEntry(key = "k2", title = "The Title", author = "Smith, John",
+                     bibtype = "Misc", year = 2018)
+    BibOptions(ignore.case = TRUE, merge.fields.to.check = c("year", "title"))
+    expect_message(bib1 + bib2, "Only duplicates")
+    expect_length(merge(bib1, bib2, ignore.case = FALSE,
+                        fields.to.check = "title"), 2)
+})
+
 test_that("head and tail", {
     expect_length(head(bib), 6L)
     expect_equal(tail(bib, 3), bib[(length(bib)-2):length(bib)])
@@ -67,7 +79,7 @@ test_that("open", {
 
     ## no error if cannot open
     expect_message(open(testbib, open.field = "eprint"),
-                   "Could not open the specified entry.")  
+                   "Could not open the specified entry.")
 
     open(bib["kastenholz"])  # DOI
     testbib <- BibEntry(bibtype = "Misc", key = "arxiv", eprinttype = "arxiv",