summarise_annotations: Describe results of a Classification/Review session

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

Describe results of a Classification/Review session

Description

Take a session identifier as input and describe the changes in the number of positive and negative matches after each Classification/Review iteration. It is necessary to run consolidate_results() before this command, otherwise the results would not consider the changes made through the manual review of the automatic classification.

Usage

summarise_annotations(
  session_name,
  sessions_folder = getOption("baysren.sessions_folder", "Sessions"),
  remove_empty_columns = TRUE,
  remove_raw_data = TRUE
)

Arguments

session_name	A session identifier corresponding to folders into the sessions_folder folder.
sessions_folder	Where to find the sessions folders.
remove_empty_columns	If TRUE, shows change columns even if no changes of that type ever happened.
remove_raw_data	Remove the tot_reviewed_ and total_records_ columns from the output, which store data and column name in machine readable column formats.

Value

A data frame reporting for a session the number of positive and negative matches after each Classification/Review iteration and the specific changes corresponding to each iteration.

Examples

## Not run: 

summarise_annotations("Session1")

## End(Not run)

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