report

Documentation

Index

• func EvaluationHeader() (header []string)
• type EvaluationFile
  • func NewEvaluationFile(writer io.Writer) (evaluationFile *EvaluationFile, err error)
  • func (e *EvaluationFile) WriteEvaluationRecord(model model.Model, language language.Language, repositoryName string, run uint, ...) (err error)
  • func (e *EvaluationFile) WriteLines(records [][]string) (err error)
• type Markdown
  • func (m Markdown) WriteToFile(path string) (err error)

Functions

func EvaluationHeader

func EvaluationHeader() (header []string)

EvaluationHeader returns the CSV header for the evaluation CSV.

Types

type EvaluationFile

type EvaluationFile struct {
	// Holds the writer where the evaluation CSV is written to.
	io.Writer
}

EvaluationFile holds the evaluation CSV file writer.

func NewEvaluationFile

func NewEvaluationFile(writer io.Writer) (evaluationFile *EvaluationFile, err error)

NewEvaluationFile initializes an evaluation file and writes the corresponding CSV header.

func (*EvaluationFile) WriteEvaluationRecord

func (e *EvaluationFile) WriteEvaluationRecord(model model.Model, language language.Language, repositoryName string, run uint, assessmentsPerCasePerTask map[string]map[task.Identifier]metrics.Assessments) (err error)

WriteEvaluationRecord writes the assessments of a task into the evaluation CSV.

func (*EvaluationFile) WriteLines

func (e *EvaluationFile) WriteLines(records [][]string) (err error)

WriteLines takes a slice of raw records and writes them into the evaluation file.

type Markdown

type Markdown struct {
	// DateTime holds the timestamp of the evaluation.
	DateTime time.Time
	// Version holds the version of the evaluation tool.
	Version string
	// Revision holds the Git revision of the evaluation tool.
	Revision string
}

Markdown holds the values for exporting a Markdown report.

func (Markdown) WriteToFile

func (m Markdown) WriteToFile(path string) (err error)

WriteToFile renders the Markdown to the given file.