Adds betterbiblatex_format option to tidy_bib_file(). Resolves #61

crsh · Feb 11, 2020 · 0afd6f9 · 0afd6f9
1 parent 0a56c35
commit 0afd6f9
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 27 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -33,4 +33,4 @@ Suggests:
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: TRUE
-RoxygenNote: 6.1.0
+RoxygenNote: 7.0.2
diff --git a/R/query_bib.R b/R/query_bib.R
@@ -12,7 +12,7 @@
 #'    Requires that the \href{https://github.com/retorquere/zotero-better-bibtex}{Better BibTeX} is installed and
 #'    Zotero/Juris-M is running.
 #' @param exclude_betterbiblatex_library Character. A vector of Zotero/Juris-M library names not to query.
-#' @param encoding Character. Encoding of the Bib(La)TeX-file.
+#' @param encoding Character. Encoding of the Bib(La)TeX-file. See the \code{\link{connection}}.
 #'
 #' @details The path to the BibTeX-file can be set in the global options and is set to
 #'    \code{references.bib} when the package is loaded. Once the path is changed in the
@@ -154,19 +154,19 @@ betterbiblatex_available <- function() {
 
 #' Load bibliography from Zotero
 #'
-#' @param increment_progress logical switch which will use the shiny function \code{incProgress} when \code{TRUE}.
-#' \code{FALSE} by default.
-#' @inheritParams query_bib
-#' @inheritParams tidy_bib_file
+#' @param increment_progress logical switch which will use the shiny function
+#'   \code{incProgress} when \code{TRUE}. \code{FALSE} by default.
 #' @inheritParams query_bib
 #'
-#' This function loads into RAM the bibliography stored in Zotero.
+#' @details This function loads into RAM the bibliography stored in Zotero.
 #' May take a several seconds if you have many hundreds of references.
 #'
 #' @export
+#'
 #' @examples \dontrun{
 #' b <- load_betterbiblatex_bib(encoding = "UTF-8")
 #' }
+
 load_betterbiblatex_bib <- function(
   encoding
   , betterbiblatex_format = "bibtex"

diff --git a/R/tidy_bib_file.R b/R/tidy_bib_file.R
@@ -5,7 +5,7 @@
 #' @param rmd_file Character. One or more paths to the R Markdown files that use the messy bibliography file.
 #' @param messy_bibliography Character. Path to the messy bibliography file.
 #' @param file Character. Path and name for the to-be-created tidy bibliography. If \code{NULL} the messy bibliography is replaced.
-#' @param encoding Character. The name of the encoding to be assumed. See the \code{\link{connection}}.
+#' @inheritParams query_bib
 #'
 #' @export
 #'
@@ -17,6 +17,7 @@ tidy_bib_file <- function(
   , messy_bibliography
   , file = NULL
   , encoding = getOption("citr.encoding")
+  , betterbiblatex_format = getOption("citr.betterbiblatex_format")
 ) {
   assert_that(is.character(rmd_file))
   assert_that(is.string(messy_bibliography))
@@ -27,6 +28,10 @@ tidy_bib_file <- function(
   }
   assert_that(is.string(encoding))
   assert_that(length(encoding) == 1)
+  assert_that(is.string(betterbiblatex_format))
+  if(!betterbiblatex_format %in% c("bibtex", "biblatex")) {
+    stop("Bibliography format not supported. Use either 'bibtex'  or 'biblatex'.")
+  }
 
   rmd <- c()
   for(i in seq_along(rmd_file)) {
@@ -59,7 +64,7 @@ tidy_bib_file <- function(
   bib_options <- RefManageR::BibOptions()
   RefManageR::BibOptions(check.entries = FALSE)
 
-  RefManageR::WriteBib(unique(necessary_bibliography), file = file, useBytes = TRUE, biblatex = getOption("citr.betterbiblatex_format") == "biblatex")
+  RefManageR::WriteBib(unique(necessary_bibliography), file = file, useBytes = TRUE, biblatex = betterbiblatex_format == "biblatex")
 
   RefManageR::BibOptions(bib_options)
 }

diff --git a/man/insert_citation.Rd b/man/insert_citation.Rd
diff --git a/man/load_betterbiblatex_bib.Rd b/man/load_betterbiblatex_bib.Rd
diff --git a/man/md_cite.Rd b/man/md_cite.Rd
diff --git a/man/query_bib.Rd b/man/query_bib.Rd
diff --git a/man/tidy_bib_file.Rd b/man/tidy_bib_file.Rd