display.dvh: 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

Usage

display.dvh(dvh, plan = NULL, Diff = FALSE, alpha.color = 1,
  title = NULL, show.plot = TRUE, decimate = TRUE,
  show.prescription = FALSE, file.name = NULL, height = 7,
  width = 7, original.colors = TRUE, fixed.scale = FALSE,
  return.dataframe = FALSE)

Arguments

dvh	single DVH (created via dvh.evaluate) or a list of DVHs
plan	plan object (optional)
Diff	display "differential" DVH (boolean, optional)
alpha.color	opacity of the plot (optional)
title	the title of the plot (optional)
show.plot	if TRUE it display the plot on screen. If FALSE it returns a ggplot plot structure if (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.prescription	plot the prescription over the DVH. The plan object needs to be specified also (boolean, optional)
height, weight	sizes (inches) of the figure to be saved in the file (optional)
fixed.scale	Forces a common fixed scale when faceting (if there are different variables).
return.dataframe	Return the data.frame of the DVH(s).
filename	the name of the file in which to save the figure (optional)
original.color	use ggplot default colors

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.combined

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