ecl-logo Documentation
ECL`

GenerateExperimentReview

GenerateExperimentReview[protocol]cloudFile

Compiles primary data and meta-data connected to the input protocol and outputs a formatted cloudFile.

Details

    Input
    Output
    General Options
    Messages
  • CanceledProtocolThe input protocol, `1`, has the Status -> `2`. No information is available to generate a review notebook. Please select an actively running or completed protocol from the Experiments dashboard.
    ProtocolNotStartedThe input protocol, `1`, has the Status -> `2`. A review notebook can only be generated for actively running or completed protocols. Please check the Experiments dashboard for an update on the protocol.

Examples

open allclose all

Basic Examples  (1)

Generate a review of a particular protocol:

Options  (4)

Preview  (1)

Preview notebook is not shown when option value is False:

PrimaryData  (1)

Insert custom data to be shown as the "Primary Data":

SecondaryData  (1)

Insert custom data to be shown as the "Secondary Data":

Upload  (1)

Notebook cloud file is not uploaded when the option value is False:

Messages  (4)

CanceledProtocol  (1)

Does not generate a review notebook if the protocol is Canceled:

IncompleteProtocol  (1)

Does not generate a review notebook if the protocol is Canceled:

ObjectDoesNotExist  (1)

Input must be an object in the database:

ProtocolNotStarted  (1)

Does not generate a review notebook if the protocol is InCart:

Last modified on Tue 4 Nov 2025 09:51:13