This is an updated, work-in-progress version of the phenotyping configuration for ISA metadata model
is a selection of MIAPPE attributes mapped to the ISA-Tab format. The most essential attributes that seem common to all phenotyping experiments are contained in the Basic Configuration. The configuration constitutes a scaffolding to construct any phenotypic dataset by adding other relevant attributes from the MIAPPE list or whatever information you wish to keep in the dataset. In case of field or greenhouse experiments, the basic attributes common to all of them are contained in Field Configuration and Greenhouse Configuration, respectively. You can extend these configurations by adding more attributes, but the list of the basic environmental information is already there.
isaconfig-phenotyping contains the configurations for constructing datasets with ISA-tools.
isa-templates provides templates of ISA text files, prefilled with protocols and material ID's (to demonstrate biological and technical replications). You can can simply edit it in you Notepad or Spreadsheet, however, it is still advisable to validate with ISA-tools. There is also an equivalent Excel workbook with ISA files as sheets (for simplicity, it's not part of ISA standard) with export-to-txt macro.
datasets includes examples of ISA-formatted phenotyping datasets.
One of the formats that can be used for a MIAPPE v1.1 submission is ISA-Tab. The present folder holds templates for each type of the I (Investigation), S (Study) and A (Assay) files, while this document explains the use of these templates. Depending on the template you choose, you might have to take slightly different actions, though the end result should be the same.
- Option 1: The spreadsheet template. Make sure to save each tab of this one as a tab-delimited text file.
- Option 2: The text files. Be careful when editing this format manually, and pay attention to the number of (tab-separated) columns in each row.
- Option 3: The configuration for the ISA Creator. Please make sure to edit out the given example values, and that the files exported in the end hold all of your data. Note that, if you only have a single Study, you will have to edit the Investigation file manually! Using the ISA Creator also allows you to run the built-in validator for your files.
For questions, please consult the MIAPPE v1.1 specification first. There you can also find more details about the expected content for each field, its format, and some examples.
Most fields/sections have an explicit mapping to MIAPPE.
Ontologies referred to in an Investigation, Study or Assay file as Terms (i.e. with a Term Source REF / Term Accession Number field) must be declared at the top of the Investigation file, in the ONTOLOGY SOURCE REFERENCE section (see section 2.2.1 here).
If you are not using the Creator, make sure that you use the proper prefixes/abbreviations to refer to classes from ontologies. -->
The Investigation section is very similar to the respective MIAPPE section. The correspondence is as follows:
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 1 | Investigation unique ID | Investigation Identifier |
| 2 | Investigation title | Investigation Title |
| 3 | Investigation description | Investigation Description |
| 4 | Submission date | Investigation Submission Date |
| 6 | Public release date | Investigation Public Release Date |
| 7 | License | Comment[License] |
| 8 | MIAPPE version | Comment[MIAPPE Version] |
In MIAPPE, only the investigation title and MIAPPE version are mandatory. Make sure that the dates you enter are in accordance with the ISO 8601 format (YYYY-MM-DD). The version, at this time, should be specified as 1.1.
For publications, MIAPPE encourages the use of DOIs, though any identifier is acceptable. However, as opposed to ISA-Tab, which allows publications on the Investigation or Study level, MIAPPE only supports Investigation-level publications.
Subsequently, an identifier is expected in the Investigation Publication DOI field. If no DOI exists for a publication, the Investigation PubMed ID field may be used.
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 9 | Associated publication | Investigation Publication DOI |
If more publications are to be listed, they should all be on the same line and separated using tabs:
Investigation Publication DOI⟶DOI_1⟶DOI_2
MIAPPE allows for the specification of people on both the Investigation and the Study level. The choice here is up to the user. For Investigation contacts, the mapping is as follows:
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 10 | Person ID | Comment[Person ID] |
| 11 | Person name | Investigation Person Last Name, Investigation Person First Name, Investigation Person Mid Initials |
| 12 | Person email | Investigation Person Email |
| 13 | Person affiliation | Investigation Person Address, Investigation Person Affiliation |
| 14 | Person role | Investigation Person Roles |
Of course, more contacts may be provided per investigation. Following the example above, separate the details for each person with a tab character. Make sure to properly align each person's attributes, even if that means having to use multiple tabs in a row, e.g.:
Comment[Person ID]⟶1⟶2
Investigation Person Last Name⟶Smith⟶Doe
Investigation Person First Name⟶John⟶Jane
Investigation Person Mid Initials⟶⟶F.
Investigation Person Email⟶jsmith@institute.edu⟶jane.doe@institute.edu
Investigation Person Address⟶campus, street, country⟶campus, street, country
Investigation Person Affiliation⟶Some institute⟶Other institute
Investigation Person Roles⟶corresponding author⟶data submitter
MIAPPE introduces new fields, most of which require ISA-Tab comments. Some fields belonging to MIAPPE Studies are divided over other ISA-Tab sections (see below).
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 15 | Study unique ID | Study Identifier |
| 16 | Study title | Study Title |
| 17 | Study description | Study Description |
| 18 | Start date of study | Comment[Study Start Date] |
| 19 | End date of study | Comment[Study End Date] |
| 20 | Contact institution | Comment[Study Contact Institution] |
| 21 | Geographic location (country) | Comment[Study Country] |
| 22 | Experimental site name | Comment[Study Experimental Site] |
| 23 | Geographic location (latitude) | Comment[Study Latitude] |
| 24 | Geographic location (longitude) | Comment[Study Longitude] |
| 25 | Geographic location (altitude) | Comment[Study Altitude] |
| 26 | Description of growth facility | Comment[Description of Growth Facility] |
| 27 | Type of growth facility | Comment[Type of Growth Facility] |
Additionally, you must use the Comment[Trait Definition File] to indicate the name of the file holding the descriptions of all observed variables. MIAPPE has no equivalent field since this information is all incorporated into the Observed Variables section.
Do not forget to indicate the name of the study file in the Study File Name field for each study. These filenames usually start with the s_ prefix.
MIAPPE's Data File section is also included here:
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 28 | Data file link | Comment[Study Data File Link] |
| 29 | Data file description | Comment[Study Data File Description] |
| 30 | Data file version | Comment[Study Data File Version] |
More data files can be included too. Make sure to tab-separate and properly align their respective attributes!
More of MIAPPE's Study attributes are mapped here.
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 31 | Description of the experimental design | Comment[Study Design Description] |
| 32 | Type of experimental design | Study Design Type |
| 33 | Observation unit level hierarchy | Comment[Observation Unit Level Hierarchy] |
| 34 | Observation unit description | Comment[Observation Unit Description] |
| 35 | Map of experimental design | Comment[Map of Experimental Design] |
Note that a class from the Crop Research Ontology (CO_715) should be provided for the Type of experimental design, and furthermore it should be a subclass of CO_715:0000003 (Experimental design).
For example, you would indicate that your experiment had a "complete block design" as CO_715:0000145.
Comment[Study Design Description]⟶Lines were repeated twice at each location using a complete block design. In order to limit competition effects, each block was organized into four sub-blocks corresponding to earliness groups based on a priori information.
Study Design Type⟶CO_715:0000145
Refer to the Investigation Publications section.
This section is the equivalent of MIAPPE's Experimental Factors.
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 36 | Experimental Factor description | Comment[Study Factor Description] |
| 37 | Experimental Factor type | Study Factor Name |
| 38 | Experimental Factor values | Comment[Study Factor Values] |
The Study Factor Name is what you must later use in the column headings (of the Study file) to refer to the respective experimental factors.
Note that at least 2 factor values must be provided per factor. This can be done in the form of a semicolon-separated list:
Comment[Study Factor Description]⟶Daily watering 1 L per plant.
Study Factor Name⟶Watering
Comment[Study Factor Values]⟶watered;unwatered
In this section, list the assay files in your ISA-Tab submission.
The value for the Study Assay Measurement Type should be phenotyping.
The Study Assay Technology Type should indicate the observation unit type that the assay is about. The content of this field should be formulated as [observation unit type] level analysis. The observation unit type should also be declared as part of the Observation Unit Level Hierarchy, specified in the Study Design Descriptors section.
An Assay file, as attached to a Study, can only reference Samples from that specific Study.
STUDY ASSAYS
Study Assay File Name⟶"a_1_phenotyping.txt"⟶"a_2_phenotyping.txt"
Study Assay Measurement Type⟶phenotyping⟶phenotyping
Study Assay Technology Type⟶plant level analysis⟶plot level analysis
This section is used for some of the fields in the MIAPPE Study section, and more fields from different sections.
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 39 | Cultural Practices | Study Protocol Description |
Note that, to indicate the above attributes, the Study Protocol Name field must always be set to "Growth" (with the same value for the Study Protocol Type).
Then, the above mapping may be followed.
Protocols in ISA-Tab can be parametrized with Protocol Parameters. We use these Parameters to present MIAPPE's Environment Parameters. Note that the environment parameters are listed under the Growth protocol in the Investigation file, but the actual values for them only appear in the Study file.
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 40 | Environment Parameter | Study Protocol Parameters Name |
Also note that multiple parameters may be listed here (separated by semicolons, not by tabs!).
For example, as far as the above attributes are concerned, this section would be composed in the following manner:
STUDY PROTOCOLS
Study Protocol Name⟶Growth
Study Protocol Type⟶Growth
Study Protocol Type Term Accession Number⟶
Study Protocol Type Term Source REF⟶
Study Protocol Description⟶Irrigation was applied according needs during summer to prevent water stress.
Study Protocol URI⟶
Study Protocol Version⟶
Study Protocol Parameters Name⟶sowing density;pH
Study Protocol Parameters Name Term Accession Number⟶
Study Protocol Parameters Name Term Source REF⟶
Study Protocol Components Name⟶
Study Protocol Components Type⟶
Study Protocol Components Type Term Accession Number⟶
Study Protocol Components Type Term Source REF⟶
Study Protocols are also used for MIAPPE Events. In this case, the mapping is as follows:
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 41 | Event type | Study Protocol Name |
| 42 | Event accession number | Study Protocol URI |
For protocols describing Events, the Study Protocol Type must always be set to "Event". Note that the accession number for each event type is in the URI field. Once again, the Crop Research Ontology (CO_715) is used, and a subclass of CO_715:0000006 (Time factor) can be given, e.g. CO_715:0000007 for the "Sowing date".
Further details about events, such as detailed descriptions, time of occurrence and affected subjects, should be defined in an external csv file (see section below).
An Event protocol may look as follows:
STUDY PROTOCOLS
Study Protocol Name⟶Planting⟶Fertilizing
Study Protocol Type⟶Event⟶Event
Study Protocol Type Term Accession Number⟶⟶
Study Protocol Type Term Source REF⟶⟶
Study Protocol Description⟶⟶
Study Protocol URI⟶CO_715:0000007⟶CO_715:0000011
Study Protocol Version⟶⟶
Study Protocol Parameters Name⟶⟶
Two additional protocols must be defined. The Sampling protocol is only required in cases where MIAPPE samples are present. This protocol is used to indicate that a sampling operation takes place, transforming material from an ISA Sample (MIAPPE equivalent: Observation unit) into an ISA Extract (MIAPPE equivalent: Sample).
The only field in this protocol is fixed. The Study Protocol Name is always "Sampling".
The respective protocol looks like:
STUDY PROTOCOLS
Study Protocol Name⟶Sampling
Study Protocol Type⟶Sampling
Study Protocol Type Term Accession Number⟶
Study Protocol Type Term Source REF⟶
Study Protocol Description⟶
Study Protocol URI⟶
Study Protocol Version⟶
Study Protocol Parameters Name⟶Sampling Date;Sampling Description
Two fields from MIAPPE's Sample section are included here: the sampling date and the sampling description. ISA-Tab also allows native Date and Description fields for Material nodes (i.e. these did not have to be explicitly declared as protocol parameters). We nevertheless encourage the use of these parameters for the sampling protocol, as the native fields cannot be included in the ISA Creator configuration, making it harder for some users.
The Phenotyping protocol must be used to indicate that observations have been conducted in a study (i.e. that something has been measured). Its mandatory attribute follow the same pattern as above: the Study Protocol Name is set to Phenotyping.
STUDY PROTOCOLS
Study Protocol Name⟶Phenotyping
Study Protocol Type⟶Phenotyping
Study Protocol Type Term Accession Number⟶
Study Protocol Type Term Source REF⟶
Study Protocol Description⟶
Study Protocol URI⟶
Study Protocol Version⟶
Study Protocol Parameters Name⟶
Finally, the Data Transformation protocol is used in Assay files, to indicate that a raw data file (included or not) has been processed to get the final results. Only its name needs to be declared in the Investigation.
STUDY PROTOCOLS
Study Protocol Name⟶Data Transformation
Study Protocol Type⟶Data Transformation
Study Protocol Type Term Accession Number⟶
Study Protocol Type Term Source REF⟶
Study Protocol Description⟶
Study Protocol URI⟶
Study Protocol Version⟶
Study Protocol Parameters Name⟶
An Investigation file may only have one Study Protocols section per STUDY. Therefore, all of the above protocols need to be consolidated into one section. Protocols not in use may be omitted.
The combined Protocols section could look as follows. Fixed fields (per protocol) are marked in this readme with *asterisks*.
STUDY PROTOCOLS
Study Protocol Name⟶*Growth*⟶Planting⟶Fertilizing⟶*Sampling*⟶*Phenotyping*⟶*Data Transformation*
Study Protocol Type⟶*Growth*⟶*Event*⟶*Event*⟶*Sampling*⟶*Phenotyping*⟶*Data Transformation*
Study Protocol Type Term Accession Number⟶⟶⟶⟶⟶⟶
Study Protocol Type Term Source REF⟶⟶⟶⟶⟶⟶
Study Protocol Description⟶Irrigation was applied according needs during summer to prevent water stress.⟶Sowing using seed drill⟶Fertilizer application: Ammonium nitrate at 3 kg/m2⟶⟶⟶
Study Protocol URI⟶⟶CO_715:0000007⟶CO_715:0000011⟶⟶⟶
Study Protocol Version⟶⟶⟶⟶⟶⟶
Study Protocol Parameters Name⟶sowing density;pH⟶⟶⟶*Collection Date;Sample Description*⟶⟶
Study Protocol Parameters Name Term Accession Number⟶⟶⟶⟶⟶⟶
Study Protocol Parameters Name Term Source REF⟶⟶⟶⟶⟶⟶
Study Protocol Components Name⟶⟶⟶⟶⟶⟶
Study Protocol Components Type⟶⟶⟶⟶⟶⟶
Study Protocol Components Type Term Accession Number⟶⟶⟶⟶⟶⟶
Study Protocol Components Type Term Source REF⟶⟶⟶⟶⟶⟶
Or, in table form (the words in italics are fixed terms for the respective protocols):
| STUDY PROTOCOLS | ||||||
|---|---|---|---|---|---|---|
| Study Protocol Name | Growth | Planting | Fertilizing | Sampling | Phenotyping | Data Transformation |
| Study Protocol Type | Growth | Event | Event | Sampling | Phenotyping | Data Transformation |
| Study Protocol Type Term Accession Number | ||||||
| Study Protocol Type Term Source REF | ||||||
| Study Protocol Description | Irrigation was applied according needs during summer to prevent water stress. | Sowing using seed drill | Fertilizer application: Ammonium nitrate at 3 kg/m2 | |||
| Study Protocol URI | CO_715:0000007 | CO_715:0000011 | ||||
| Study Protocol Version | ||||||
| Study Protocol Parameters Name | sowing density;pH | Collection Date;Sample Description | ||||
| Study Protocol Parameters Name Term Accession Number | ||||||
| Study Protocol Parameters Name Term Source REF | ||||||
| Study Protocol Components Name | ||||||
| Study Protocol Components Type | ||||||
| Study Protocol Components Type Term Accession Number | ||||||
| Study Protocol Components Type Term Source REF |
Each row in the Study file represents a single MIAPPE Observation unit, which has the ISA Sample as its equivalent.
The Study file starts by specifying the plant materials in each observation unit. Then the Growth protocol (holding certain Study parameters and the environmental attributes) must be given, followed by the name of the observation unit itself (Sample NAme), and its attributes (type, spatial information, etc). At the end of the row, factors values (based on the factors specified in the Investigation file) may be specified per observation unit.
The Sampling and Phenotyping protocols may only be applied in Assay files.
The file, therefore follows this structure:
| Source Name | Characteristics[...] | Protocol REF | Parameter Value[env. param 1] | Parameter Value[env. param 2] | Protocol REF | Parameter Value[...] | Sample Name | Characteristics[...] | Factor Value[...] |
|---|---|---|---|---|---|---|---|---|---|
| source 1 | Growth | other | exp. unit A | ||||||
| source 2 | Growth | exp. unit B |
[todo: fix numbers]
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 43 | Biological material ID | Source Name |
| 44 | Organism | Characteristics[Organism] |
| 45 | Genus | Characteristics[Genus] |
| 46 | Species | Characteristics[Species] |
| 47 | Infraspecific name | Characteristics[Infraspecific Name] |
| 48 | Biological material latitude | Characteristics[Biological Material Latitude] |
| 49 | Biological material longitude | Characteristics[Biological Material Longitude] |
| 50 | Biological material altitude | Characteristics[Biological Material Altitude] |
| 51 | Biological material coordinates uncertainty | Characteristics[Biological Material Coordinates Uncertainty] |
| 52 | Biological material preprocessing | Characteristics[Biological Material Preprocessing] |
| 53 | Material source ID (Holding institute/stock centre, accession) | Characteristics[Material Source ID] |
| 54 | Material source DOI | Characteristics[Material Source DOI] |
| 55 | Material source latitude | Characteristics[Material Source Latitude] |
| 56 | Material source longitude | Characteristics[Material Source Longitude] |
| 57 | Material source altitude | Characteristics[Material Source Altitude] |
| 58 | Material source coordinates uncertainty | Characteristics[Material Source Coordinates Uncertainty] |
| 59 | Material source description | Characteristics[Material Source Description] |
The ISA configuration allows, by default, only specific observation unit types, taken from the corresponding MIAPPE definition:
Type of observation unit in textual form, usually one of the following:
study,block,sub-block,plot,sub-plot,pot,plant.
Note that the current definition in MIAPPE has a trial level instead of the study level, but this will be changed in the next revision of the standard.
It is not possible to use sub-plant observation levels: The plant level is the lowest level in the hierarchy.
However, observations can still be made on the sub-plant level, as long as the details are indicated in the associated observed variable (see observed variables).
Alternatively, it is possible to use samples (i.e. ISA Extracts) for more detailed tracing of sub-plant units, attaching the observations to them instead.
The observation unit type is stated in the study file, and repeated in each of the assay files.
This list of possible values for the observation unit types column is non-exhaustive, but it should cover the majority of cases. It is possible to use a different unit type in the Creator (and in the Validator) by editing the configuration as follows:
The following section (around lines 95-99) looks as follows:
<field data-type="list" header="Characteristics[Observation Unit Type]" is-file-field="false" is-forced-ontology="false" is-hidden="false" is-multiple-value="false" is-required="true">
<description><![CDATA[(MIAPPE: Observation unit type) Type of observation unit in textual form, usually one of the following: study, block, sub-block, plot, sub-plot, pot, plant]]></description>
<default-value><![CDATA[plant]]></default-value>
<list-values>study,block,sub-block,plot,sub-plot,pot,plant</list-values>
</field>
Add the name of your unit to the list of allowed values:
<list-values>**[new_unit_type]**,study,block,sub-block,plot,sub-plot,pot,plant</list-values>
e.g.
<list-values>superblock,study,block,sub-block,plot,sub-plot,pot,plant</list-values>
The name of the file should reflect the name of the new observation unit type and adhere to the pattern phenotyping_[new_unit_type]_level.txt, e.g. phenotyping_superblock_level.txt.
The following lines have to be changed:
- On line 3, the
table-nameshould include the name of the new unit type, e.g.<isatab-configuration isatab-assay-type="generic_assay" isatab-conversion-target="generic" table-name="superblock_block_level"> - On line 5, the
term-labelshould also include the name of the new unit type, e.g.<technology source-abbreviation="" term-accession="" term-label="superblock level analysis"/> - Modify line 12 to include the name of the new observation unit type in the list of values (should be the same as the respective line in the study configuration file), e.g.
<list-values>superblock,study,block,sub-block,plot,sub-plot,pot,plant</list-values>
You may then use the new unit type in the ISA Creator.
Finally, any factor value must be attributed to the observation units. Factors, and their respective possible values, must be previously declared in the Investigation file too.
| Sample Name | Characteristics[...] | Factor Value[Watering] |
|---|---|---|
| exp. unit 1 | ... | watered |
| exp. unit 2 | ... | watered |
| exp. unit 3 | ... | unwatered |
For more details about the specific meaning, contents and format of each field, see the MIAPPE specification file.
The assay file starts with the Samples column (MIAPPE observation units) as defined in the study file. Then the Protocols should follow: Sampling may be used if there are any MIAPPE Samples (i.e. ISA-Tab Extracts) to speak of. The Phenotyping protocol must always be used in the end. The Sampling Date, a parameter value to the Sampling protocol, column is mandatory for Extracts, to indicate the collection date. The Date is not mandatory for the Phenotyping protocol.
Overall, the Sampling protocol applies on an ISA Sample (MIAPPE observation unit), and transforms a material (from a sample) into an Extract (MIAPPE sample). The sampling parameters describe the process, and the extract characteristics describe the resulting material.
Broadly, the columns in assay files follow the order (optional ones in [brackets]):
- Sample Name (must be listed in the corresponding study file)
- [Sample Characteristics]
- [Sampling protocol, if there are Extracts in use (MIAPPE Samples)]
- [Extracts, if in use, with their Characteristics]
- Other protocols with their parameters (minimally, the Phenotyping protocol)
- Assay Name
- Raw Data File
- [Data Transformation protocol, with parameters (if one wishes to provide a Derived Data File)]
- [Derived Data File]
Additionally, each assay file should be about one observation unit type. This type can be given under the Assay Name column.
For the MIAPPE samples, the mapping is as follows:
| Field # | MIAPPE | ISA-Tab |
|---|---|---|
| 64 | Sample ID | Extract Name |
| 65 | Plant structure development stage | Characteristics[Plant Structure Development Stage] |
| 66 | Plant anatomical entity | Characteristics[Plant Anatomical Entity] |
| 67 | Sample description | Parameter Value[Sample Description] |
| 68 | Collection date | Parameter Value[Collection Date] |
| 69 | External ID | Characteristics[External ID] |
The two Parameter Values in the above mapping both refer to the Sampling protocol.
The Sampling protocol can be applied as follows. The Plant structure development stage and the plant anatomical entity, according to MIAPPE recommendations, must refer to ontology classes.
| Sample Name | Protocol REF | Parameter Value[Collection Date] | Parameter Value[Sample Description] | Extract Name | Characteristics[Plant Structure Development Stage] | Characteristics[Plant Anatomical Entity] | Characteristics[External ID] |
|---|---|---|---|---|---|---|---|
| exp. unit A | Sampling | 2017-06-22 | sample I | ||||
| exp. unit B | Sampling | 2017-06-23 | sample II |
Observations made at the sub-plant level should be recorded as plant level observations using the observed variables to characterize the object of the observation (e.g. Berry sugar content, Fruit weight, Grain Protein content, Leaf 1 width, Leaf 2 width, Leaf 2 length).
Including the Phenotyping protocol is mandatory. The Phenotyping protocol connects a Sample node to an Assay, optionally through an Extract.
Note that each assay should be about a single observation unit type.
| Sample Name | (sampling details) | Protocol REF | Date | Assay Name | Raw Data File | Protocol REF | Derived Data File |
|---|---|---|---|---|---|---|---|
| sample A | Phenotyping | block | file 1 | Data Transformation | file 2 | ||
| sample B | Phenotyping | block | NA | Data Transformation | file 2 |
The Date column is optional (you will have to add it in the ISA Creator too, if you choose to include it), and in this case it would refer to the timestamp of a measurement done on an observation unit or (MIAPPE) sample.
It is up to the user to decide whether the raw or processed files will accompany the metadata. If no raw data file is included, fill the respective fields with "NA". Note that the transition from raw to processed data file is marked using the Data Transformation protocol.
The trait definition file includes the attributes from MIAPPE's Observed Variable section. The column headers are directly taken from MIAPPE, so no mapping is listed here. An example could be the following:
| Variable ID | Variable Name | Variable Accession Number | Trait | Trait Accession Number | Method | Method Accession Number | Method Description | Reference Associated to the Method | Scale | Scale Accession Number | Time Scale |
|---|---|---|---|---|---|---|---|---|---|---|---|
| Ant_Cmp_Cday | Anthesis computed in growing degree days | CO_322:0000794 | Anthesis time | CO_322:0000030 | Growing degree days to anthesis | CO_322:0000189 | Days to anthesis for male flowering was measured in thermal time (GDD: growing degree-days) according to Ritchie J, NeSmith D (1991;Temperature and crop development. Modeling plant and soil systems American Society of Agronomy Madison, Wisconsin USA) with TBASE=8°C and T0=30°C. | http://doi.org/10.2134/agronmonogr31.c2 | °C day | CO_322:0000510 | Growing degree day (GDD) |
There should be one trait definition file per study. Its filename is indicated in the Study section of the Investigation file.
Climatological variables should also be listed in the same file, the same way.
An external .csv file is used to describe concrete occurrences of events. Although external files are outside the scope of ISA validation, the events listed in this file should be declared in the Study Protocols section of the Investigation file.
This means that there will be redundancy for certain fields ().
The csv file should look like this:
| Study ID* | Observation Unit(s) | Event Date* | Event Type | Event Accession Number | Event Description |
|---|---|---|---|---|---|
| s_1 | NA | 2006-09-27T10:23:21+00:00 | Planting | CO_715:0000007 | Sowing using seed drill |
| s_1 | obs_unit_1, obs_unit_2 | 2006-09-28T10:23:21+00:00 | Fertilizing | CO_715:0000011 | Fertilizer application: Ammonium nitrate at 3 kg/m2 |
| s_1 | obs_unit_1, obs_unit_2 | 2006-10-28T10:23:21+00:00 | Fertilizing | CO_715:0000011 | Fertilizer application: Ammonium nitrate at 2 kg/m2 |
| s_1 | obs_unit_3 | 2006-10-29T10:23:21+00:00 | Fertilizing | CO_715:0000011 | Fertilizer application: Ammonium nitrate at 3 kg/m2 |
| s_2 | obs_unit_A | 2006-10-29T10:23:21+00:00 | Fertilizing | CO_715:0000011 | Fertilizer application: Ammonium nitrate at 3 kg/m2 |
Each line in this file represents a single occurrence of an Event, and should therefore have exactly one date. The Observation Unit(s) column should list all affected units (multiple units are allowed on each row). If the column is empty, it is understood that this instance of the event affected all units in the study. Note that each event type may happen on multiple dates.
There is no official format for the data file. However, we recommend something like the following:
| Observation Unit ID / Extract ID | Observation Timestamp | Obs. Var. 1 ID | Obs. Var. 2 ID | Obs. Var. 3 ID |
|---|---|---|---|---|
| obs. unit X | value | value | ... | |
| obs. unit Y | value | |||
| obs. unit Z | ... |
The identity of the observation unit or sample, the observation time and the observed variable identifiers MUST be included in the data file. Other columns, depending on the data providers' preferences (e.g. about material identification, experimental factors or design) may be included as well but are fully optional.
For time series data it is possible to repeat the columns after the first one.
After filling in all fields, please verify that the names of materials, protocols, parameters and variables are consistent across all ISA files. Do the same for the ontologies used. Depending on the filetype you are using:
- If you are using the ISA Creator and you have a single study, please make sure to edit the produced Investigation file and fill in all necessary fields.