SEP 18 -- Attachment
|Authors||Bryan Bartley (firstname.lastname@example.org), Chris Myers (email@example.com), Nicholas Roehner (firstname.lastname@example.org), and SBOL Developers (authors, please opt in)|
|Editor||Nicholas Roehner (email@example.com)|
Table of Contents
- 1. Rationale
- 2. Specification
- 3. Examples
- 4. Backwards Compatibility
- 5. Discussion
- 6. Relation to Other SEPs
To specify a general container for a file attachment including metadata that helps tools interpret the file
Attachment class is a general container for data files, especially experimental data files.
Attachment is a
TopLevel object, and any other
TopLevel object can refer to a list of
Attachment has the following properties:
The source is a link to the external file and is REQUIRED.
The format is an ontology term indicating the format of the file. It is RECOMMENDED to use the EDAM ontology for file formats, which includes a variety of experimental data formats. The
format is an OPTIONAL field
The size is a long integer indicating the file size in bytes. This may be used by client applications accessing files over RESTful APIs. This field is OPTIONAL.
The hash is a string used to retrieve files from a cache. This field is OPTIONAL.
Figure 1: Diagram of the
Attachment class and its associated properties
Attachments wrap an experimental data file and include important meta-data that helps tools interpret the data. This example attaches quality control data in the form of a gel image and sequencing results.
This proposal does not affect backwards compatibility.
This proposal has been discussed extensively at HARMONY 2017 and on the Github issue tracker. There is general consensus that an
Attachment is needed.
This proposal relates to SEP 019, which deals with how experimental data should be linked to SBOL as part of encoding the provenance for design-build-test-learn cycles in synthetic biology.
To the extent possible under law, SBOL developers has waived all copyright and related or neighboring rights to SEP 013. This work is published from: United States.