You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| Deprecating old response format | The old response format for tabular data will be deprecated. The **"multi_value"** response format (introduced in July 2023) will be the default option. It allows retrieval of data with one or more features and suits any type of tabular data, including **.gct** files. |
@@ -535,6 +536,7 @@ Please review the documentation, as these changes may impact your integrations.
535
536
536
537
537
538
* ??? danger "Affected endpoints (for both as-curator and as-users)"
| Introducing **“variant”** section | A new section **“variant”** contains all fields related to a specific variation from the original VCF file: CHROM, POS, ID, REF, ALT, QUAL, FILTER, INFO. |
@@ -553,6 +556,7 @@ Please review the documentation, as these changes may impact your integrations.
553
556
554
557
555
558
* ??? danger "Affected endpoints (for both as-curator and as-users)"
| Introducing **“feature”** and **“value”** sections | Flow-cytometry data response now has section **“feature”** including **"readoutType"**, **"cellPopulation"** and **"marker"** fields. **“Value”** section contains the expression field which is renamed to **“value”**.|
@@ -572,6 +577,7 @@ Please review the documentation, as these changes may impact your integrations.
572
577
573
578
574
579
* ??? danger "Affected endpoints (for both as-curator and as-users)"
This guide will help you navigate the main features of the Open Data Manager as a Data Consumer.
3
+
This guide will help you navigate the main features of the Open Data Manager as a Data Consumer. Please note that all users are Consumers by default
4
4
5
5
## Main Page
6
6
7
-
When you open ODM you will be taken to the start page or “Dashboard” as shown below:
7
+
When you open ODM you will be taken to the start page or **Dashboard**. Here you can access important links to the Quick Start guide, the User Guides, and documentation for the API, and share your feedback.
8
8
9
+
<figure markdown="span">
9
10
11
+
<figcaption>The main dashboard contains access to useful information, including Quick Start examples, User Guides, and API endpoints documentation</figcaption>
12
+
</figure>
10
13
11
14
## Browse Studies
12
15
13
16
As a Data Consumer, you can browse and explore various studies.
14
17
15
-
To search and browse studies, click on the **“Browse studies”** button on the dashboard/start page.
18
+
To search and browse studies, click on the **Browse studies** button on the dashboard/start page.
<figcaption>Browse studies: to search and browse studies, click on the <strong>Browse studies</strong> button on the dashboard/start page</figcaption>
23
+
</figure>
18
24
19
25
## Search for Data
20
26
21
27
Apply filters to search for specific studies. For example, select filters using the criteria in the panel on the left,
22
28
such as Data Class, Organism, etc.
23
29
24
-
!!! info "The exact filters you see may vary due to the data contained within your ODM system. Administrators can lock which facets are available for all users."
30
+
!!! info
31
+
The exact filters you see may vary depending on the data contained within your ODM. Administrators can lock which facets are available for all users.
<figcaption>Users can apply filters to refine their search, including Organism, Data Class, Organization Name, Study Type, Study Source, etc.</figcaption>
29
36
</figure>
30
37
31
38
The system's search functionality is designed to enhance user experience and efficiency by allowing users
32
-
to look up specific keywords effortlessly. By entering terms such as **"bowel"**, users can quickly access a range
33
-
of relevant studies. Additionally, the search bar is equipped with an intuitive autocomplete feature,
39
+
to look up specific keywords effortlessly.
40
+
By entering terms such as **"bowel"**, users can quickly access a range
41
+
of relevant studies.
42
+
43
+
Additionally, the search bar is equipped with an intuitive autocomplete feature,
34
44
which not only predicts and suggests potential search terms but also provides values from various ontologies.
35
45
This ensures a more streamlined and accurate search process, making it easier to navigate through the available
Use the search bar to find specific keywords, such as **"bowel"** to display relevant studies.
41
-
The autocomplete feature also suggests values from various ontologies.
50
+
<figcaption>Use the search bar to find specific keywords, such as <strong>bowel</strong> to display relevant studies. The autocomplete feature also suggests values from various ontologies</figcaption>
51
+
</figure>
42
52
43
53
## Select a Study
44
54
45
55
After applying the desired filters to narrow down your search results, you will see a list of studies
46
56
that match your criteria. To delve deeper into a specific study, simply click on the corresponding icon.
47
57
This action will open the study, allowing you to review its details and findings comprehensively.
<figcaption>Once the filters have been applied, and you find a study of interest, click on it to open it.</figcaption>
62
+
</figure>
50
63
51
64
The study will open in a new tab, where the following tabs can be explored:
52
-
**Study:** Shows the study metadata.
53
-
**Samples:** Contains all the samples' metadata.
54
-
**Data:** Details of the files linked or attached to the study.
55
65
66
+
- **Study:** Shows the study metadata.
67
+
- **Samples:** Contains all the samples' metadata.
68
+
- **Data:** Details of the files linked or attached to the study.
69
+
70
+
<figure markdown="span">
56
71
72
+
<figcaption>The selected study displays three main tabs: <strong>Study, Samples, and Data</strong>, each offering different sets of information related to the study</figcaption>
73
+
</figure>
57
74
58
75
### Accession number
59
76
60
77
In addition, a unique accession number is automatically generated for each study in the ODM.
61
78
The accession number allows you to identify the specific study and to further work with the study via API endpoints.
62
79
Learn more about API endpoints and functionalities in the API User Guide.
63
80
81
+
<figure markdown="span">
64
82
83
+
<figcaption>Every study imported to the ODM contains a unique identifier named accession number. You can visualize the accession number on the <strong>Study</strong> tab, or you can copy the accession number by clicking on the top bar of the main page and selecting <strong>Copy accession</strong></figcaption>
84
+
</figure>
65
85
66
86
Every study imported to the ODM contains a unique identifier named accession number.
67
87
You can visualize the accession number on the Study tab, or you can copy the accession number
@@ -72,24 +92,48 @@ by clicking on the top bar of the main page and selecting “copy accession”
<figcaption>Explore numerical data associated with the combined plot</figcaption>
129
+
</figure>
90
130
91
131
7. To export the plot in SVG or PNG formats, simply hover over the top right corner of the plot. A menu with three dots :material-dots-horizontal: will appear, allowing you to select the desired format for download. The available formats for downloading the plot are SVG and PNG.
<figcaption>Export combined and single attribute plots in SVG and PNG formats</figcaption>
136
+
</figure>
93
137
94
138
## Export Data
95
139
@@ -101,7 +145,10 @@ Export all the information contained in the study. Note that some studies may ha
101
145
102
146
!!! warning "If some externally stored data is inaccessible due to its removal from the original external storage (the link to the storage is invalid), the study cannot be exported."
<figcaption>Export the data by clicking on the <strong>Export</strong> option in the top right corner of the screen. Files will be compressed, and once ready, the folder can be downloaded to the user’s local computer</figcaption>
151
+
</figure>
105
152
106
153
By following these steps, you can efficiently browse, visualize, and export data as a Data Consumer using
0 commit comments