display.dvh.combined: Display DVHs

In planit-group/Rplanit: Radiotherapy with ion beams - planning, simulations and analysis

Display DVHs

Description

Display a single DVH or a list of DVHs with the possibility to use cumulative or differential representations.

Usage

display.dvh.combined(dvh, type = "both", alpha.color = 1,
  title = NULL, decimate = TRUE, unique.variable = FALSE,
  show.plot = TRUE, original.colors = TRUE, filename = NULL,
  width = 7, height = 7)

Arguments

dvh	single DVH (created via dvh.evaluate) or a list of DVHs
type	type of display: 'cumulative', 'differential', or 'both' (default)
alpha.color	opacity of the plot (optional)
title	the title of the plot (optional)
decimate	if the DVH points are too much (> 1000), it plots only a sample of them, to speed up the visualization (boolean, optional)
show.plot	if TRUE it display the plot on screen. If FALSE it returns a ggplot plot structure if (optional)
filename	the name of the file in which to save the figure (optional)
height, weight	sizes (inches) of the figure to be saved in the file (optional)

Value

If show.plot is FALSE, it returns a ggplot2 plot structure to be used for further processing. If return.dataframe = TRUE it returns the generated data.frame of the DVH(s).

See Also

Other display dvh: display.dvh

planit-group/Rplanit documentation built on Dec. 5, 2022, 11:10 p.m.