generate.report: Generate report

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

Generate report

Description

Generate a report summarizing the plan in a file with the markdown format (it can be converted in html via rstudio or the "markdown" package).

Usage

generate.report(plan, file.name = "report", N.slice = 6,
  html = FALSE)

Arguments

plan	the plan object
file.name	the file name
N.slice	number of slices to plot for CT and value distributions
html	output html file. Note: there is an issue with markdown package that prevents the correct latex equation display in html. Opening the markdown (*.md) file in Rstudio, and then previewing it, overcomes this issue (Rstudio uses an internal markdown to html conversion).

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