| unitizer_result {unitizer} | R Documentation |
Return Values and Related Methods for unitize Functions
Description
unitize and related functions are run primarily for the interactive
environment they provide and for their side effects (updating stored
unitizer objects), but the return values may be useful under some
circumstances if you need to retrieve test status, user selections, etc..
Usage
## S3 method for class 'unitizer_result'
print(x, ...)
## S3 method for class 'unitizer_results'
print(x, ...)
Arguments
x |
the object to print |
... |
extra arguments for print generic |
Details
unitize and review return a unitizer_result S3 object.
This is a data frame that contains details about the status of each test.
unitize_dir returns a unitize_results S3 object, which is a
list of unitize_result objects.
Both unitize_results and unitize_result have print
methods documented here. In addition to the print methods, both of
the result objects have get_unitizer methods so that you can
retrieve the stored unitizer objects.
Please note that with unitize_dir you can re-review a single
unitizer several times during during a single call to
unitize_dir. This is to allow you to re-evaluate specific
unitizers easily without having to re-run the entire directory again.
Unfortunately, as a result of this feature, the return values of
unitize_dir can be misleading because they only report the result of
the last review cycle.
Additionally, unitize_dir will report user selections during the last
review even if in the end the user chose not to save the modified
unitizer. You will be alerted to this by an onscreen message from the
print method (this is tracked in the "updated" attribute of the
unitizer_result object). Finally, if in the last iteration before
exit you did not save the unitizer, but you did save it in previous
review cycles in the same unitize_dir call, the displayed selections
and test outcomes will correspond to the last unsaved iteration, not the
one that was saved. You will be alerted to this by an on-screen message
(this is tracked through the "updated.at.least.once" attribute of the
unitizer_result object).
Value
x, invisibly