Skip to content

slight README changes #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rm1113 merged 1 commit into from
Sep 19, 2025
Merged

slight README changes #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@

## Overview

Python tool for validating H5AD AnnData files before uploading to the Cell Annotation Platform. The same validation code is used in [Cell Annotation Platform](https://celltype.info/) following requirements from the CAP-AnnData schema published [here](https://github.com/cellannotation/cell-annotation-schema/blob/main/docs/cap_anndata_schema.md).
Python tool for validating H5AD AnnData files before uploading to the Cell Annotation Platform. The same validation code is used in [Cell Annotation Platform](https://celltype.info/) following requirements from the CAP-AnnData schema published [here](https://github.com/cellannotation/cap-data-schema/blob/main/cap-anndata-schema.md).

Full documentation could be found in the [GitHub Wiki](https://github.com/cellannotation/cap-validator/wiki)

## Features
- ✨ Validates all upload requirements and returns results at once
Expand All @@ -31,7 +33,6 @@ uv = UploadValidator(h5ad_path)
uv.validate()
```

Full documentation could be found in [GitHub Wiki](https://github.com/cellannotation/cap-validator/wiki)

### CLI interface
```console
Expand Down