Skip to content

Commit 83a3e96

Browse files
authored
Merge pull request #95 from genestack/feature/supported-data-hdf5
HDF5 file info added
2 parents b7d6ebf + 3cf4b99 commit 83a3e96

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/user-guide/supported-data/supported-data.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,44 @@ in our **Advanced User Guide**.
163163

164164
## HDF5 (e.g. Single Cell)
165165

166+
!!! info "Limitations"
167+
HDF5 is supported as Attached File in ODM with ability to observe and search by File Structure (Contents) only.
168+
We are working on full functionality for HDF5 data content parsing, search, and filtering.
169+
170+
**HDF5 (Hierarchical Data Format version 5)** is a widely used data format in genomic research, particularly in
171+
Single Cell studies. It is designed to store large, complex datasets efficiently, making it a preferred choice for
172+
structured biological data such as gene expression matrices and metadata.
173+
174+
The ODM now supports HDF5 file upload as Attached File, search by File Structure (Contents), and manage these
175+
files within Studies.
176+
177+
### Supported HDF5 Formats
178+
179+
- **.h5, .h5ad** - Standard HDF5 files
180+
- **.h5.gz, .h5ad.zip** - Compressed versions of standard HDF5 files
181+
182+
### Viewing File Structure (Contents)
183+
184+
- **Access File Contents via GUI**: The ODM displays File Contents on the Data Tab of Metadata Editor. It is
185+
accessible on `Contents` button click.
186+
- **Retrieve File Contents via API**: You can retrieve File Contents for the list of files or by unique
187+
Genestack Accession.
188+
189+
### Searching HDF5 Files by File Contents
190+
191+
Users can search via GUI and API for:
192+
193+
- **Unique File**: by Genestack Accession.
194+
- **Files**:
195+
196+
- By File Contents fields/pathways.
197+
- By Study Genestack Accession.
198+
199+
- **Studies**:
200+
201+
- By File Contents fields/pathways.
202+
- By File Genestack Accession.
203+
166204
For a detailed description and instructions on using HDF5, visit the **[Supported Data Formats page](../doc-odm-user-guide/supported-formats.md)**
167205
in our **Advanced User Guide**.
168206

0 commit comments

Comments
 (0)