{"_id":"56b537252d7fc00d0037f498","user":"56b534d0168b5c1700c159a7","__v":4,"category":{"_id":"56b534f35f1cf00d00cc475d","__v":10,"project":"56b534f15f1cf00d00cc4759","version":"56b534f25f1cf00d00cc475c","pages":["56b534f45f1cf00d00cc475f","56b5368185a6922300d1c538","56b5369a168b5c1700c159a9","56b536b4eed075230097d75e","56b536c32d7fc00d0037f496","56b5370a5997532100bc6c30","56b537147bccae0d00e9a1d0","56b537252d7fc00d0037f498","56b5372e5997532100bc6c32","56b5373d7719bb190014307a"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-05T23:49:07.518Z","from_sync":false,"order":9999,"slug":"documentation","title":"Documentation"},"project":"56b534f15f1cf00d00cc4759","githubsync":"","version":{"_id":"56b534f25f1cf00d00cc475c","project":"56b534f15f1cf00d00cc4759","__v":4,"createdAt":"2016-02-05T23:49:06.439Z","releaseDate":"2016-02-05T23:49:06.439Z","categories":["56b534f35f1cf00d00cc475d","56b55e5b5f1cf00d00cc477c","56b55e605f1cf00d00cc477d","56b5fac7e205510d001e4cfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-05T23:58:29.656Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"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.\n\nThe report instance contains the following information.\n\n  * The executed experiment name.\n  * Information about the executed control callable.\n  * Information about the executed trial callables.\n\nLet's take a look at the methods that are available on a report instance.\n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n\\n$report->getName();\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\nThe `getName()` method will return the name of the experiment that was executed.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n\\n$report->getControl();\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\nThe `getControl()` method will return a [result](doc:results) instance describing the execution of the control callable.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n\\n$report->getTrial('name');\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\nThe `getTrial()` method can be used to retrieve a [result](doc:results) instance by trial name. This instance contains information describing the execution of the trial callable.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n\\n$report->getTrials();\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\nThe `getTrials()` method will return an associative array of trial name, to trial result instance pairs. That's right, all of your trials!","excerpt":"View experiment result information.","slug":"reports","type":"basic","title":"Reports"}

Reports

View experiment result information.

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. [block:code] { "codes": [ { "code": "<?php\n\n$report->getName();", "language": "php" } ] } [/block] The `getName()` method will return the name of the experiment that was executed. [block:code] { "codes": [ { "code": "<?php\n\n$report->getControl();", "language": "php" } ] } [/block] The `getControl()` method will return a [result](doc:results) instance describing the execution of the control callable. [block:code] { "codes": [ { "code": "<?php\n\n$report->getTrial('name');", "language": "php" } ] } [/block] The `getTrial()` method can be used to retrieve a [result](doc:results) instance by trial name. This instance contains information describing the execution of the trial callable. [block:code] { "codes": [ { "code": "<?php\n\n$report->getTrials();", "language": "php" } ] } [/block] The `getTrials()` method will return an associative array of trial name, to trial result instance pairs. That's right, all of your trials!