Skip to content

Commit 4a5924d

Browse files
authored
Update example-use-2.md
1 parent 7681d8b commit 4a5924d

1 file changed

Lines changed: 193 additions & 0 deletions

File tree

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
# DataTools4Heart Catalogue
2+
3+
1. [Introduction](#1-introduction)
4+
2. [Homepage](#2-homepage)
5+
3. [Main Navigation Overview](#3-main-navigation-overview)
6+
4. [Repository Section](#4-repository-section)
7+
- [Repository Overview](#41-repository-overview)
8+
- [Individual Studies](#42-individual-studies)
9+
- [Study Detail Page](#43-study-detail-page)
10+
- [Datasets](#44-datasets)
11+
- [Variables](#45-variables)
12+
5. [Search Functionality](#5-search-functionality)
13+
6. [Data Access Process (Public View)](#6-data-access-process-public-view)
14+
7. [Approved Projects (Public View)](#7-approved-projects-public-view)
15+
8. [Tips for Navigation](#8-tips-for-navigation)
16+
9. [Troubleshooting & FAQ (Public Access)](#9-troubleshooting--faq-public-access)
17+
10. [Glossary (Relevant Terms)](#11-glossary-relevant-terms)
18+
19+
---
20+
21+
## 1. Introduction
22+
23+
The **DataTools4Heart Catalogue** is an AI-ready cardiology dataset discovery portal based on the **Mica (OBiBa)** platform.
24+
It provides public access to study metadata, dataset descriptions, variables, and access request procedures.
25+
It does **not** host raw individual-level data; rather, it provides metadata, summary statistics and information on how to gain access
26+
27+
This manual explains how to navigate the **public-facing** sections of the catalogue.
28+
29+
---
30+
31+
## 2. Homepage
32+
33+
When you access the website, the homepage introduces the catalogue and provides the main navigation menu.
34+
35+
**Screenshot Placeholder:**
36+
`![Homepage](images/homepage.png)`
37+
38+
The landing page shows a top navigation menu with:
39+
- A search bar (“Search networks, studies, datasets and variables …”) to type keywords.
40+
- Quick links to Individual Studies, Collected Datasets, Variables.
41+
42+
Also a brief description of the catalogue content with some statistics, like the number of variables or datasets.
43+
44+
---
45+
46+
## 3. Main Navigation Overview
47+
48+
The top navigation bar usually contains links such as:
49+
- **Home**
50+
- **Repository**
51+
- **Data Access Process**
52+
- Other informational pages (About, Contact, etc.)
53+
54+
---
55+
56+
## 4. Repository Section
57+
58+
### 4.1 Repository Overview
59+
60+
The Repository serves as the entry point to studies, datasets, and variables.
61+
62+
**Screenshot Placeholder:**
63+
`![Repository Overview](images/repository_overview.png)`
64+
65+
You can explore metadata in read-only mode without logging in.
66+
67+
---
68+
69+
### 4.2 Individual Studies
70+
71+
Clicking on *Individual Studies* displays a list of cardiology-related studies.
72+
73+
**Screenshot Placeholder:**
74+
`![Studies List](images/studies_list.png)`
75+
76+
Each study entry usually shows:
77+
- Study title
78+
- Brief description
79+
- Metadata or links to datasets
80+
81+
You can click on any study to see more details.
82+
83+
---
84+
85+
### 4.3 Study Detail Page
86+
87+
A public study page typically includes:
88+
- Description
89+
- Objectives
90+
- Institutions or data owners
91+
- Datasets linked to that study
92+
93+
**Screenshot Placeholder:**
94+
`![Study Example](images/study_example.png)`
95+
96+
---
97+
98+
### 4.4 Datasets
99+
100+
Under *Collected Datasets*, you can view a public list of available dataset descriptions.
101+
102+
**Screenshot Placeholder:**
103+
`![Datasets List](images/datasets_list.png)`
104+
105+
Information may include:
106+
- Dataset title
107+
- Associated study
108+
- Brief overview
109+
110+
---
111+
112+
### 4.5 Variables
113+
114+
The *Variables* section allows public browsing of variable names and limited metadata.
115+
116+
**Screenshot Placeholder:**
117+
`![Variables List](images/variables_list.png)`
118+
119+
Users can typically see:
120+
- Variable label/name
121+
- Source (study/dataset)
122+
- Data type or category (if displayed publicly)
123+
124+
---
125+
126+
## 5. Search Functionality
127+
128+
The catalogue includes a global search bar or a dedicated search page. You can search studies, datasets, or variables by keywords.
129+
130+
**Screenshot Placeholder:**
131+
`![Search Page](images/search_page.png)`
132+
133+
---
134+
135+
## 6. Data Access Process (Public View)
136+
137+
A dedicated page explains:
138+
- Steps to request data
139+
- Eligibility or governance structure
140+
- Policies and conditions
141+
142+
**Screenshot Placeholder:**
143+
`![Data Access Process](images/data_access_process.png)`
144+
145+
As a public user, you can read the procedures before any account-based actions.
146+
147+
---
148+
149+
## 7. Approved Projects (Public View)
150+
151+
Some catalogues display a public list of projects that have already obtained data access.
152+
153+
**Screenshot Placeholder:**
154+
`![Approved Projects](images/approved_projects.png)`
155+
156+
This section may include:
157+
- Project title
158+
- Lead institution
159+
- Summary or objectives
160+
161+
---
162+
163+
## 8. Tips for Navigation
164+
165+
- Use the main menu to switch quickly between sections.
166+
- Explore the Repository first to understand the scope of cardiology datasets.
167+
- Use keywords in the search bar to find relevant studies or variables quickly.
168+
- Public view generally does **not** allow data downloads or detailed variable inspection.
169+
170+
---
171+
172+
## 9. Troubleshooting & FAQ (Public Access)
173+
174+
| Issue | Explanation | Suggested Action |
175+
|------|-------------|-------------------|
176+
| Limited metadata visibility | Public mode hides detailed fields | Consider contacting catalogue administrators |
177+
| No download option | Public view does not include direct access | Refer to the Data Access Process page |
178+
| Broken links or missing info | Under maintenance or restricted | Wait or report to support contacts |
179+
180+
181+
---
182+
183+
## 10. Glossary (Relevant Terms)
184+
185+
- **Mica / OBiBa**: Software platform for metadata cataloguing and data access management.
186+
- **Study**: A research initiative providing structured datasets.
187+
- **Dataset**: A collection of data fields associated with a study. In DT4H context, it corresponds to a group of features hosted in a particular federated node.
188+
- **Variable**: A specific data element or field within a dataset. In DT4H context, it corresponds to AI-ready features
189+
- **Data Access Request**: Formal process for requesting restricted data.
190+
191+
- Tutorials for requesting AI-ready cardiology data
192+
193+
---

0 commit comments

Comments
 (0)