This is an issue used for tracking a decision that was made in OPIL 1.0a4 release for encoding Strateo's protocol ID in opil.parse_strateos_json(). Every protocol, when fetched from Strateos, has a protocol ID. This ID value comes into play when a user of Intent Parser would like to execute an experiment and protocol ID must be provided to complete this request. Since Intent Parser is relying on the OPIL library to perform conversion from Strateos data schema to OPIL, Intent Parser will need this information converted and stored in an OPIL object.
After talking with @bbartley , we have decided that this information will be encoded using custom annotation. Since protocol ID is specific to Strateos, it is best to have this information nested in a custom object rather than a ProtocolInterface object. We can revisit this topic of where to encode this information in the future when there are more labs supporting OPIL in their tool (ex: UW Aquarium).
This is an issue used for tracking a decision that was made in OPIL 1.0a4 release for encoding Strateo's protocol ID in opil.parse_strateos_json(). Every protocol, when fetched from Strateos, has a protocol ID. This ID value comes into play when a user of Intent Parser would like to execute an experiment and protocol ID must be provided to complete this request. Since Intent Parser is relying on the OPIL library to perform conversion from Strateos data schema to OPIL, Intent Parser will need this information converted and stored in an OPIL object.
After talking with @bbartley , we have decided that this information will be encoded using custom annotation. Since protocol ID is specific to Strateos, it is best to have this information nested in a custom object rather than a ProtocolInterface object. We can revisit this topic of where to encode this information in the future when there are more labs supporting OPIL in their tool (ex: UW Aquarium).