Skip to content

Single-cell data transformation documentation#193

Merged
tropnikovvl merged 75 commits intodevelopfrom
docs/sc-transformations
Apr 9, 2026
Merged

Single-cell data transformation documentation#193
tropnikovvl merged 75 commits intodevelopfrom
docs/sc-transformations

Conversation

@isabel-gomez-gs
Copy link
Copy Markdown
Contributor

@isabel-gomez-gs isabel-gomez-gs commented Mar 26, 2026

This PR introduces the full documentation set for the single-cell HDF5 transformation feature in ODM.

New guides and references: Added quickstart guide, how-to guides, API reference, configuration reference, transformation process reference, and attribute mapping reference for the hdf5-cells transformation pipeline.

Supporting materials: Added example configurations and import commands for public datasets, plus a configuration-to-dataset mapping table.

Conceptual overview: Added about-sc-hdf5-transformations.md explaining the entities involved and how the transformation works.

PS: The linked jupyter notebooks are not available yet as they have been pushed in a different PR. They can be checked in branch docs/notebooks

Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
isabel-gomez-gs and others added 24 commits March 30, 2026 08:39
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Co-authored-by: Maria Borodaenko <Maria.borodaenko@genestack.com>
Comment thread docs/user-guide/doc-odm-user-guide/about-sc-hdf5-transformations.md Outdated
@isabel-gomez-gs isabel-gomez-gs marked this pull request as ready for review April 1, 2026 16:39
@isabel-gomez-gs isabel-gomez-gs requested review from a team as code owners April 1, 2026 16:39
@isabel-gomez-gs isabel-gomez-gs changed the title Single-cell data transformation draft documents Single-cell data transformation documentation Apr 1, 2026
Copy link
Copy Markdown

@predragmacura predragmacura left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs are well written. PR contains clean explanation, references and the how-to guide. Minor overlaps between Diataxis types have been observed. After addressing a few issues, we are good to go! Great job!

Comment thread docs/user-guide/doc-odm-user-guide/transformation-process-reference.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/transformation-process-reference.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/transformation-process-reference.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/transformation-process-reference.md Outdated
Comment thread docs/user-guide/doc-odm-user-guide/transformation-process-reference.md Outdated
predragmacura
predragmacura previously approved these changes Apr 6, 2026
Comment thread docs/user-guide/doc-odm-user-guide/quickstart-sc.md
MariaBorodaenko
MariaBorodaenko previously approved these changes Apr 9, 2026
@tropnikovvl tropnikovvl merged commit 0c75ab1 into develop Apr 9, 2026
2 checks passed
@tropnikovvl tropnikovvl deleted the docs/sc-transformations branch April 9, 2026 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants