...
LinkML allows modeling that makes use of techniques such as "inheritance," , where the attributes of a template class may be may be included another class. For more information about inheritance, refer to see the LinkML documentation (available at https://linkml.io/linkml/schemas/inheritance.html). Some of these techniques have been used in the definition of the ARS Model to ensure consistency of class definitions, apply data constraints, and facilitate the representation of ARS data in various data formats. To simplify the descriptions of the use and representation of analysis and output definitions in ARS format, some of the details of the more complex modeling techniques may not be included in this user guide. However, all details are available in the HTML Model documentation.
The Section 2, Analysis Results Model section of this user guide contains separate, , contains class-specific pages describing structure and use of the class. Each of these pages contains:
- A link to the corresponding HTML Model documentation
- A high-level description of the purpose of the class and where it is used within the definition of a reporting event.
- A diagram showing the structure of the class and its relationships with other classes. The Mermaid tool has been used to define and render these diagrams. Either of 2 types of diagram is used on each page:
- A Class Diagram is used when it is necessary to illustrate the inheritance of attributes between classes. Refer to the Mermaid documentation for class diagrams (available at https://mermaid.js.org/syntax/classDiagram.html) for information about components of class diagrams.
- An Entity Relationship (ER) Diagram is used in all other cases. Refer to the Mermaid documentation for ER diagrams (available at https://mermaid.js.org/syntax/entityRelationshipDiagram.html) for more information about the components of ER diagrams.
- A description of each of the attributes of the class and how they are populated.
- At least one 1 implementation example, showing how the attributes of the class may be populated for 1 or more instances of the class, or how instances of the class may be referenced in other parts of the model. These examples always include example data represented in YAML format and may also include the same example data represented in tabular format. YAML is a text-based "human-readable data serialization language"—i.e., a compact and understandable way to represent hierarchical data. In YAML, data is represented as attribute/value pairs; the attribute name is shown first, followed by a colon and then the value.
- If the attribute contains a single simple value (such as e.g., a number of a text string), this is represented on the same line as the attribute name, e.g.,; for example:
textAttribute: Some text value here
numericAttribute: 1.2 - If the attribute contains an instance of another class, the attributes of the contained class are shown indented below the containing attribute, e.g.,; for example:
complexAttribute:
textSubAttribute: Value for first attribute of the contained class
numericSubAttribute: 0
complexSubAttribute:
textSubSubAttribute: xxx
numericSubSubAttribute: 8.5 - If the attribute contains a list of values, each value in the list is shown indented below and preceded by a hyphen, e.g.,; for example:
textListAttribute:
- first text value
- second text value
numericListAttribute:
- 18
- 24
- 6.5
complexListAttribute:
- textSubAttribute: text value for first attribute of first entry in list
numericSubAttribute: 1.0
- textSubAttribute: text value for first attribute of second entry in list
numericSubAttribute: 2.0
- If the attribute contains a single simple value (such as e.g., a number of a text string), this is represented on the same line as the attribute name, e.g.,; for example:
...