get_source_distribution: Distribution of the number of sources in common per record

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

Distribution of the number of sources in common per record

Description

Describe the distribution of the number of sources shared by records.

Usage

get_source_distribution(annotation_file, as_propr = TRUE, format_fun = percent)

Arguments

annotation_file	An annotation data frame or a file path to it.
as_propr	Whether to output the results as absolute numbers or proportions over the record total.
format_fun	If the results are shown as proportion (as_propr == TRUE), which function to use to format them.

Value

A named vector with the number of sources in common as names and the absolute number/proportion as values.

Examples

## Not run: 
# Get the annotation file
Annotation_file <- get_session_files("Session1")$Annotations[1]

# Transform it into a list
get_source_distribution(Annotation_file)

## End(Not run)

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