Conversation
|
|
||
| Users with appropriate permissions can create new templates. Refer to the section User Setup for more on user roles and permissions. Templates can be created via: | ||
|
|
||
| * **Python Script**: Import a new template using JSON files. Follow the instructions in the [Create a new template](https://github.com/genestack/user-docs/blob/develop/docs/tools/odm-sdk/terminal/templates/create-or-update-template.md) section on the ODM GitHub page. |
There was a problem hiding this comment.
we don't have to provide any link to the github, please, use current user guide pages instead: <server_address>/user-docs/tools/odm-sdk/terminal/templates/create-or-update-template/, also please update the screenshot
There was a problem hiding this comment.
Updated + image removed and deleted
|
|
||
| Templates include the following metadata options: | ||
|
|
||
| * **Name**: The name of the metadata field that should be included (e.g., “Accession,” “Organism”). |
There was a problem hiding this comment.
Let's remove "Accession" from examples? :)
| Templates include the following metadata options: | ||
|
|
||
| * **Name**: The name of the metadata field that should be included (e.g., “Accession,” “Organism”). | ||
| * **Required**: Indicates whether the metadata field is mandatory. If a required field is left blank or incorrectly filled, it will be highlighted in red. |
There was a problem hiding this comment.
it will be highlighted in red -> it will be highlighted in red in Metadata Editor?
| ## Exploring Templates | ||
|
|
||
| **Tabular data fields:** | ||
| Click on any template to open it in a new window and explore its features. This window displays the components of the template for each part of your study: |
There was a problem hiding this comment.
in a new window
Template is opened in the same tab
| * Flow Cytometry | ||
|
|
||
| - `Features (numeric)` | ||
|  |
There was a problem hiding this comment.
This screenshot shown the state actual only for releases before 1.61, will we update it?
| Alternatively, access the Template Editor from a study by opening the study, clicking on the study title in the top bar, then clicking on the template title and selecting **Explore**. | ||
|
|
||
| - `Data Class` (for Tabular, Variants, and Flow Cytometry data) | ||
|  |
There was a problem hiding this comment.
This screenshot also shown outdated template view for the release 1.61
| * **Dictionary**: Standardized terms for data curation and validation. | ||
| * **Description**: A hint or description for the attribute shown during curation. | ||
|
|
||
|  |
There was a problem hiding this comment.
The same comment about the screenshot that I left earlier
|
|
||
| * **Grouping Metadata Fields**: Group fields under a common header using the **"/"** character (e.g., Signature/Initial and Signature/Quintile). | ||
|
|
||
|  |
There was a problem hiding this comment.
The same comment about the screenshot that I left earlier
|  | ||
| <figcaption>Access the <strong>Template Editor</strong> from an open study by clicking on the study title, then the template name, and <strong>Explore</strong></figcaption> | ||
|
|
||
| ## Edit Template Metadata |
There was a problem hiding this comment.
I believe we also have to mention that after changing anything these changes should be saved (button in the header should be pressed), let's add this detail and a screenshot.
|
|
||
| For example, the **NCBI ontology** organizes species names hierarchically, aiding in accurate classification and analysis. | ||
|
|
||
|  |
There was a problem hiding this comment.
The same comment about the screenshot that I left earlier
|
|
||
| From the **Metadata Editor**, click the study name, then **Apply another** and select | ||
| the template of interest from the list of suggested files. Click **Explore** to open it with the Template Editor. | ||
|  |
There was a problem hiding this comment.
The same comment about the screenshot that I left earlier
3 participants
The section has been updated and new subsections have been added, including: Dictionaries, Ontologies and Validation