report.ranked.list: Generates a benchmarking report without bootstrapping results

In wiesenfa/challengeR: Analyzing assessment data of biomedical image analysis competitions and visualization of results

Generates a benchmarking report without bootstrapping results

Description

Generates a benchmarking report in PDF, HTML or Word format without bootstrapping results. It contains the rankings, plots of the raw assessment data and plots of the ranking stability. For multi-task challenges, it also contains plots of cross-task insights. If you are interested in the individual plots as separate files, set argument clean to FALSE and specify fig.format.

Usage

## S3 method for class 'ranked.list'
report(
  object,
  consensus,
  file,
  title = "<Challenge name>",
  colors = default_colors,
  format = "PDF",
  latex_engine = "pdflatex",
  clean = TRUE,
  fig.format = NULL,
  dpi = 150,
  open = TRUE,
  ...
)

Arguments

object	The ranked assessment data set.
consensus	The rank aggregation across tasks (consensus ranking). Only needed for a multi-task data set.
file	A string specifying the file name of the report. It allows for specifying the output file path as well, otherwise the working directory is used. If file does not have a file extension, an extension will be automatically added according to the output format given in format. If the argument is omitted, the report is created in a temporary folder with file name "report".
title	A string specifying the title of the report.
colors	The color scheme that is applied to the plots.
format	A string specifying the format of the report. The options are "PDF", "HTML" or "Word".
latex_engine	A string specifying the LaTeX engine for producing PDF output. The Options are "pdflatex", "lualatex", and "xelatex".
clean	A boolean indicating whether intermediate files (e.g. individual plots) should be kept. Using TRUE will clean intermediate files that are created during rendering.
fig.format	A vector of strings containing the file format of the figures that are not removed if clean is set to FALSE. The options are "jpeg", "png" and "pdf", e.g. fig.format = c("jpeg", "png", "pdf").
dpi	A positive integer specifying the resolution of the generated plot (fig.format "jpeg" or "png") in dots per inch (DPI).
open	A boolean specifying whether the report should be opened with the default system viewer after generation.
...	Further arguments passed to or from other functions.

wiesenfa/challengeR documentation built on Aug. 25, 2023, 6:43 a.m.