format_performance: Pretty formatting of Session performance analysis

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

Pretty formatting of Session performance analysis

Description

Publication friendly formatting of the results of estimate_performance(). If more than one results set is passed (i.e., one per session), the will be added as new columns.

Usage

format_performance(..., session_names = NULL)

Arguments

...	One or more performance result data frames produced by estimate_performance().
session_names	Names of the sessions corresponding to the result data frames passed to .... If missing, they will be "Session" followed by an incremental number for each data frame passed to ....

Value

A long format data frame with the statistical indicators on the first column and a column with values for each data frame passed to ....

Examples

## Not run: 
Performance <- list(
  s1 = get_session_files("Session1")$Annotations %>% last() %>%
    import_data() %>% estimate_performance(),
  s2 = get_session_files("Session2")$Annotations %>% last() %>%
    import_data() %>% estimate_performance()
)

format_performance(Performance$s1, Performance$s2)

## End(Not run)

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