From 775cf4baacd218255bdc23cdfc1df0c4f6c9f085 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 30 Jul 2024 16:21:02 +0000 Subject: [PATCH] Documentation --- man/plot_source_overlap_heatmap.Rd | 2 +- man/reimport_ris.Rd | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/man/plot_source_overlap_heatmap.Rd b/man/plot_source_overlap_heatmap.Rd index 16ce3514..9da11cb7 100644 --- a/man/plot_source_overlap_heatmap.Rd +++ b/man/plot_source_overlap_heatmap.Rd @@ -15,7 +15,7 @@ plot_source_overlap_heatmap( } \arguments{ \item{data}{A tibble with one record per row, an id column and then one column -per source indicating whether the record was found in that source.} +per source indicating whether the record was found in that source (usually obtained from \code{compare_sources()})} \item{cells}{Variable to display in the cells. Should be 'source', 'label' or 'string'} diff --git a/man/reimport_ris.Rd b/man/reimport_ris.Rd index 66ff8753..7424023c 100644 --- a/man/reimport_ris.Rd +++ b/man/reimport_ris.Rd @@ -9,6 +9,8 @@ reimport_ris( source_field = "DB", label_field = "C7", string_field = "C8", + duplicate_id_field = "C1", + record_id_field = "C2", tag_naming = "ris_synthesisr", verbose = TRUE ) @@ -22,6 +24,10 @@ reimport_ris( \item{string_field}{Character. Which RIS field should cite_strings be read from? NULL to set to missing} +\item{duplicate_id_field}{Character. Which RIS field should duplicate IDs be read from? NULL to recreate based on row number (note that neither duplicate nor record IDs directly affect CiteSource analyses - they can only allow you to connect processed data with raw data)} + +\item{record_id_field}{Character. Which RIS field should record IDs be read from? NULL to recreate based on row number} + \item{tag_naming}{Synthesisr option specifying how RIS tags should be replaced with names. This should not be changed when using this function to reimport a file exported from CiteSource. If you import your own RIS, check \code{names(CiteSource:::synthesisr_code_lookup)} and select any of the options that start with \code{ris_}}