summarise_by_source: Record distribution between sources in an Annotation file

In bakaburg1/BaySREn: BaySREn. An R package to automatise citation collection and screening in Systematic Reviews. Based on Bayesian active machine learning

Record distribution between sources in an Annotation file

Description

Summarises the distribution of the source databases among the citation records in an Annotation data set. It also reports the fraction of records that are unique for each database.

Usage

summarise_by_source(
  annotation_file,
  as_data_frame = FALSE,
  add_session_totals = TRUE
)

Arguments

annotation_file	An annotation data frame or a file path to it.
as_data_frame	Whether to return the results as a data frame (TRUE) or a list (FALSE).
add_session_totals	Whether to add the total number of record.

Value

For each source:

Records	The number of records related to the source.
% over total	the percentage over the total records.
Source specific records	the number of record derived only from that source.
% over source total	the value in Source specific records as percentage over the source total.

If as_data_frame is TRUE, the results are returned as a data frame with a row for each source, otherwise as a nested list. add_session_totals adds another entry with the total number of records in the annotation_file.

Examples

## Not run: 

records <- get_session_files("Session1")$Records

summarise_by_source(records)

## End(Not run)

bakaburg1/BaySREn documentation built on March 30, 2022, 12:16 a.m.