questionComments: Define a Commenting Scheme

Description

These functions are used to specify how the result of a comparison between two objects should be converted to a set of comments for feedback.

Usage

questionComments(answerNames, ...)
comments(answerName, ...)
transformComment(pattern, comment)

Arguments

answerNames

The names of objects that have been compared.

answerName

The name of one object that has been compared.

pattern

A regular expression to search for within the comparison transformations.

comment

A comment to record if the regular expression is matched.

...

For questionComments, zero or more comments (as generated by the the comments() function); for comments(), zero or more transformation comments (as generated by the transformComment() function.

Value

An object of class "questionComments".

Details

These functions are used to define a commenting scheme. The function commentQuestions() can then be used to apply the results to a set of comparisons, as generated by compareFiles().

Examples

Run this code

# Comment a comparison involving several objects
# Start with a comment of 1 and deduct 1 if the comparison failed
questionComments(c("id", "age", "edu", "class"),
                 comments("class",
                          transformComment("coerced",
                                           "'class' is a factor!")))