Skip to contents

Produces an interactive HTML report summarizing all results from sonar_analyse(): consolidated metrics, lint issues with file navigation, style violations, test coverage and technical debt.

Usage

sonar_report(
  x,
  output = "rsonar_report.html",
  title = "rsonar Quality Report",
  open = interactive()
)

Arguments

x

An rsonar_result object returned by sonar_analyse().

output

Path to the output HTML file. Default "rsonar_report.html".

title

Report title. Default "rsonar Quality Report".

open

Open the report in a browser after generation. Default interactive().

Value

The path to the generated HTML file (invisibly).

Examples

if (FALSE) { # \dontrun{
res <- sonar_analyse(".")
sonar_report(res, output = "quality.html")
} # }