read_and_decorate_code_and_alerts: Read a source code and, with its alerts, make it nice to put...

Description Usage Arguments Value

View source: R/functions.R

Description

Read a source code and, with its alerts, make it nice to put on a markdown document

Usage

1
2
3
4
5
6
7
read_and_decorate_code_and_alerts(
  file,
  alerts,
  region_only = FALSE,
  region_size = 3,
  use_mnemonic = FALSE
)

Arguments

file

source code file which matches with the alerts

alerts

alerts from an output of calculate_features, output$versions_executed$pmd_output[[i]]

region_only

must the output contain only the region with alerts?

region_size

how many lines must the region near the alert contained in the output have?

Value

a nice markdown content to be put on a markdown document


crotman/kludgenudger documentation built on Oct. 19, 2021, 7:30 p.m.