From 26ae4d3a1ad4383898c084dcdc09b91803fe3acb Mon Sep 17 00:00:00 2001
From: Trevor Riley <89118428+TNRiley@users.noreply.github.com>
Date: Thu, 23 May 2024 22:33:29 -0400
Subject: [PATCH] Update import.R

Updated examples in documentation for read_citations function
---
 R/import.R | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/R/import.R b/R/import.R
index 1584646..869dc30 100644
--- a/R/import.R
+++ b/R/import.R
@@ -15,22 +15,22 @@
 #' @return A tibble with one row per citation
 #' @examples
 #' if (interactive()) {
+#'   # Import only key fields from the RIS files
 #'   read_citations(c("res.ris", "res.bib"),
 #'     cite_sources = c("CINAHL", "MEDLINE"),
 #'     cite_strings = c("Search1", "Search2"),
-#'     cite_labels = c("raw", "screened")
+#'     cite_labels = c("raw", "screened"),
+#'     only_key_fields = TRUE
 #'   )
-#'   
+#'
 #'   # or equivalently
-#'   
-#'   metadata_tbl <- tibble::tribble(
-#'    ~files,     ~cite_sources, ~cite_strings, ~cite_labels, 
-#'   "res.ris",  "CINAHL",      "Search1",     "raw", 
-#'   "res.bib",  "MEDLINE",     "Search2",     "screened"
+#'   metadata_tbl_key_fields <- tibble::tribble(
+#'    ~files,     ~cite_sources, ~cite_strings, ~cite_labels, ~only_key_fields,
+#'   "res.ris",  "CINAHL",      "Search1",     "raw",        TRUE,
+#'   "res.bib",  "MEDLINE",     "Search2",     "screened",   TRUE
 #'   )
-#'   
-#'   read_citations(metadata = metadata_tbl)
-#'   
+#'
+#'   read_citations(metadata = metadata_tbl_key_fields)
 #' }
 #' @export