Shorten doc. examples for CRAN

Author: mwmclean

R/BibEntryExtractOp.R

@@ -96,68 +96,64 @@ MatchName <- function(nom, pattern, match.author=.BibOptions$match.author,
 #' @family operators
 #' @rdname SearchBib
 #' @examples
-#' if (requireNamespace("bibtex")) {
-#'     file.name <- system.file("Bib", "biblatexExamples.bib", package="RefManageR")
-#'     bib <- suppressMessages(ReadBib(file.name))
+#' file.name <- system.file("Bib", "biblatexExamples.bib", package="RefManageR")
+#' bib <- suppressMessages(ReadBib(file.name))
 #'
-#'     ## author search, default is to use family names only for matching
-#'     bib[author = "aristotle"]
+#' ## author search, default is to use family names only for matching
+#' bib[author = "aristotle"]
 #'
-#'     ## Aristotle references before 1925
-#'     bib[author="aristotle", date = "/1925"]
+#' ## Aristotle references before 1925
+#' bib[author="aristotle", date = "/1925"]
 #'
-#'     ## Aristotle references before 1925 *OR* references with editor Westfahl
-#'     bib[list(author="aristotle", date = "/1925"),list(editor = "westfahl")]
+#' ## Aristotle references before 1925 *OR* references with editor Westfahl
+#' bib[list(author="aristotle", date = "/1925"),list(editor = "westfahl")]
 #'
-#'     ## Change some searching and printing options and search for author
-#'     old.opts <- BibOptions(bib.style = "authoryear", match.author = "exact",
-#'       max.names = 99, first.inits = FALSE)
-#'     bib[author="Mart\u00edn, Jacinto and S\u00e1nchez, Alberto"]
-#'     BibOptions(old.opts)  ## reset options
+#' ## Change some searching and printing options and search for author
+#' old.opts <- BibOptions(bib.style = "authoryear", match.author = "exact",
+#'                        max.names = 99, first.inits = FALSE)
+#' bib[author="Mart\u00edn, Jacinto and S\u00e1nchez, Alberto"]
+#' BibOptions(old.opts)  ## reset options
 #'
-#'     ## Some works of Raymond J. Carroll's
-#'     file.name <- system.file("Bib", "RJC.bib", package="RefManageR")
-#'     bib <- ReadBib(file.name)
-#'     length(bib)
+#' \dontrun{
+#'   ## Some works of Raymond J. Carroll's
+#'   file.name <- system.file("Bib", "RJC.bib", package="RefManageR")
+#'   bib <- ReadBib(file.name)
+#'   length(bib)
 #'
-#'     ## index by key
-#'     bib[c("chen2013using", "carroll1978distributions")]
+#'   ## index by key
+#'   bib[c("chen2013using", "carroll1978distributions")]
 #'
-#'     ## Papers with someone with family name Wang
-#'     length(SearchBib(bib, author='Wang', .opts = list(match.author = "family")))
+#'   ## Papers with someone with family name Wang
+#'   length(SearchBib(bib, author='Wang', .opts = list(match.author = "family")))
 #'
-#'     ## Papers with Wang, N.
-#'     length(SearchBib(bib, author='Wang, N.', .opts = list(match.author = "family.with.initials")))
+#'   ## Papers with Wang, N.
+#'   length(SearchBib(bib, author='Wang, N.', .opts = list(match.author = "family.with.initials")))
 #'
-#'     ## tech reports with Ruppert
-#'     length(bib[author='ruppert',bibtype="report"])
+#'   ## tech reports with Ruppert
+#'   length(bib[author='ruppert',bibtype="report"])
 #'
-#'     ##Carroll and Ruppert tech reports at UNC
-#'     length(bib[author='ruppert',bibtype="report",institution="north carolina"])
+#'   ##Carroll and Ruppert tech reports at UNC
+#'   length(bib[author='ruppert',bibtype="report",institution="north carolina"])
 #'
-#'     ## Carroll and Ruppert papers since leaving UNC
-#'     length(SearchBib(bib, author='ruppert', date="1987-07/",
-#'        .opts = list(match.date = "exact")))
-#' }
+#'   ## Carroll and Ruppert papers since leaving UNC
+#'   length(SearchBib(bib, author='ruppert', date="1987-07/",
+#'                    .opts = list(match.date = "exact")))
 #'
-#' ## Carroll and Ruppert papers NOT in the 1990's
-#' \dontrun{
-#' if (requireNamespace("bibtex")) {
-#'     length(SearchBib(bib, author='ruppert', date = "!1990/1999"))
-#'     identical(SearchBib(bib, author='ruppert', date = "!1990/1999"),
-#'       SearchBib(bib, author='ruppert', year = "!1990/1999"))
-#'     table(unlist(SearchBib(bib, author='ruppert', date="!1990/1999")$year))
+#'   ## Carroll and Ruppert papers NOT in the 1990's
+#'  length(SearchBib(bib, author='ruppert', date = "!1990/1999"))
+#'  identical(SearchBib(bib, author='ruppert', date = "!1990/1999"),
+#'           SearchBib(bib, author='ruppert', year = "!1990/1999"))
+#'  table(unlist(SearchBib(bib, author='ruppert', date="!1990/1999")$year))
 #'
-#'     ## Carroll + Ruppert + Simpson
-#'     length(bib[author="Carroll, R. J. and Simpson, D. G. and Ruppert, D."])
+#'  ## Carroll + Ruppert + Simpson
+#'  length(bib[author="Carroll, R. J. and Simpson, D. G. and Ruppert, D."])
 #'
-#'     ## Carroll + Ruppert OR Carroll + Simpson
-#'     length(bib[author=c("Carroll, R. J. and Ruppert, D.", "Carroll, R. J. and Simpson, D. G.")])
+#'  ## Carroll + Ruppert OR Carroll + Simpson
+#'  length(bib[author=c("Carroll, R. J. and Ruppert, D.", "Carroll, R. J. and Simpson, D. G.")])
 #'
-#'     ## Carroll + Ruppert tech reports at UNC "OR" Carroll and Ruppert JASA papers
-#'     length(bib[list(author='ruppert',bibtype="report",institution="north carolina"),
-#'       list(author="ruppert",journal="journal of the american statistical association")])
-#' }
+#'  ## Carroll + Ruppert tech reports at UNC "OR" Carroll and Ruppert JASA papers
+#'  length(bib[list(author='ruppert',bibtype="report",institution="north carolina"),
+#'             list(author="ruppert",journal="journal of the american statistical association")])
 #' }
 `[.BibEntry` <- function(x, i, j, ..., drop = FALSE){
 

R/BibEntryReplaceOp.R

@@ -20,7 +20,21 @@
 #' @keywords methods manip
 #' @family operators
 #' @examples
-#' if (requireNamespace("bibtex")) {
+#' bib.text <- "@Manual{mclean2014,
+#'   author = {Mathew William McLean},
+#'   title = {Straightforward Bibliography Management in R Using the RefManager Package},
+#'   note = {arXiv: 1403.2036 [cs.DL]},
+#'   year = {2014},
+#'   url = {https://arxiv.org/abs/1403.2036},
+#' }"
+#' tfile <- tempfile(fileext = ".bib")
+#' writeLines(bib.text, tfile)
+#' bib <- ReadBib(tfile)
+#' bib[1] <- list(c(date = "2014-03", key = "mwm2014"))
+#' bib
+#' unlink(tfile)
+#' 
+#' \dontrun{
 #'     file.name <- system.file("Bib", "RJC.bib", package="RefManageR")
 #'     bib <- ReadBib(file.name)
 #'     print(bib[seq_len(3L)], .opts = list(sorting = "none", bib.style = "alphabetic"))

R/ReadBib.R

@@ -24,7 +24,18 @@
 #' @seealso \code{\link[bibtex]{read.bib}} in package \code{bibtex}
 #' @export
 #' @examples
-#' if (requireNamespace("bibtex")) {
+#' bib.text <- "@Manual{mclean2014,
+#'   author = {Mathew William McLean},
+#'   title = {Straightforward Bibliography Management in R Using the RefManager Package},
+#'   note = {arXiv: 1403.2036 [cs.DL]},
+#'   year = {2014},
+#'   url = {https://arxiv.org/abs/1403.2036},
+#' }"
+#' tfile <- tempfile(fileext = ".bib")
+#' writeLines(bib.text, tfile)
+#' ReadBib(tfile)
+#' unlink(tfile)
+#' \dontrun{
 #'     file.name <- system.file("Bib", "RJC.bib", package="RefManageR")
 #'     bib <- ReadBib(file.name)
 #' }