logIssue: Manage error messages associated with a StudentRecord.

logIssueR Documentation

Manage error messages associated with a StudentRecord.

Description

The function logIssue() adds an issue to a StudentRecord. The function getIssues() returns a list of issues.

Usage

logIssue(sr, issue)
## S4 method for signature 'StudentRecord,ANY'
logIssue(sr,issue)
## S4 method for signature 'StudentRecord,character'
logIssue(sr,issue)
getIssues(sr)
## S4 method for signature 'StudentRecord'
getIssues(sr)

Arguments

sr

A StudentRecord object to be examined or modified.

issue

An issue to be logged. This should be a character object or something which can be coerced to a character object.

Details

The idea is to be able to log error messages and warning which occur when processing evidence for this person. These are converted to strings, so they can be saved

Value

The function getIssues() returns a character vector containing the encountered issues.

The function logIssue() returns the modified student record.

Author(s)

Russell Almond

See Also

StudentRecord, markAsError

Examples


sr0 <-
    StudentRecord("S1","*baseline*",as.POSIXct("2020-03-30 09:00:00"))

sr0 <- logIssue(sr0,"Test Issue")
err <- simpleError("Another test error.")
sr0 <- logIssue(sr0,err)
getIssues(sr0)


ralmond/EABN documentation built on Aug. 30, 2023, 12:52 p.m.