Reports

Reports contain a snapshot of result information from an executed experiment. They are handed to Journals automatically, or we can retrieve a report instance by using report() instead of run() on an experiment.

The report instance contains the following information.

• The executed experiment name.
• Information about the executed control callable.
• Information about the executed trial callables.

Let's take a look at the methods that are available on a report instance.

$report->getName();

The getName() method will return the name of the experiment that was executed.

$report->getControl();

The getControl() method will return a result instance describing the execution of the control callable.

$report->getTrial('name');

The getTrial() method can be used to retrieve a result instance by trial name. This instance contains information describing the execution of the trial callable.

$report->getTrials();

The getTrials() method will return an associative array of trial name, to trial result instance pairs. That's right, all of your trials!