From 7dd2934cd6ac245ba6f9776b8bd38a609f3d5e20 Mon Sep 17 00:00:00 2001 From: Chia-Lin Lin <42910431+cllde8@users.noreply.github.com> Date: Wed, 18 Oct 2023 19:12:02 +0200 Subject: [PATCH] Create ontology.mdx --- docs/eln/ui/ontology.mdx | 56 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/eln/ui/ontology.mdx diff --git a/docs/eln/ui/ontology.mdx b/docs/eln/ui/ontology.mdx new file mode 100644 index 00000000..ed13f38f --- /dev/null +++ b/docs/eln/ui/ontology.mdx @@ -0,0 +1,56 @@ +--- +title: Ontology +author: Claire Lin +--- + +The "Ontology Selection" function in the system utilises the EMBL-EBI ontology lookup service as the primary data source. After retrieving the data from the EMBL-EBI ontology lookup service, we employ a process that focuses on extracting and retaining ontology terms related to "RXNO" (Name Reaction Ontology) and "CHMO" (Chemical Methods Ontology). These selected ontological terms are subsequently presented as options for user selection within the system. + +:::info +It's important to emphasize that we do not utilize the entire datasets for "RXNO" and "CHMO"; instead, we selectively incorporate relevant portions to meet the user's needs. The reason for selectively using only specific segments of the "RXNO" and "CHMO" data is to optimize the user experience by simplifying the selection process. This approach also helps to avoid the potential confusion that may arise from the presence of too many options. +::: + +## Functionality + +Users can select ontology terms related to "RXNO" and "CHMO" in a targeted manner, thus promoting an academic approach to data categorisation and facilitating accurate data representation in the context of reactions and analyses. + +### CHMO (Chemical Methods Ontology) of Analysis + +![chmo_analysis](/img/ontology/chmo_analysis.png) + +### RXNO (Name Reaction Ontology) of Reaction + +![rxno_reaction](/img/ontology/rxno_reaction.png) + +## Usage + +The options of the "Ontology Selection" function are organized within a tree-like structure, making it a particularly user-friendly feature. This structure is well-suited for any data with hierarchical entries, allowing users to navigate and select from the available options with ease. + +![hierarchical_entries](/img/ontology/hierarchical_entries.png) + +### Recently Selected + +The system keeps the user's most selected options in the 'Recently selected' so the user can easily select the ontology. + +The following video demonstrates how it works: + + + +### Searchable Selection + +Another useful feature is that the system provides search functionality within the selection, allowing you to filter out the options by entering the value you want. + +The following video demonstrates how it works: + + + +## Administration + +Given the variety of ontologies that may be required for different applications, we have provided a feature that allows system administrators to enable/disable ontology terminology within the system. Please check [Admin Interface > Load OLS Terms](/docs/eln/admin/ontology.mdx) for further information.