diff --git a/README.md b/README.md index 48955b2..63faea6 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ The TileDB matrix file is stored in a **cell X gene** orientation. This orientat is chosen because the fastest-changing dimension as new files are added to the collection is usually the cells rather than genes. +![`CellArrDataset` structure](./assets/cellarr.png "CellArrDataset") + ***Note: Currently only supports either paths to H5AD or `AnnData` objects*** To build a `CellArrDataset` from a collection of `H5AD` or `AnnData` objects: diff --git a/assets/cellarr.jpg b/assets/cellarr.jpg new file mode 100644 index 0000000..d78ae34 Binary files /dev/null and b/assets/cellarr.jpg differ diff --git a/assets/cellarr.png b/assets/cellarr.png new file mode 100644 index 0000000..5e2008d Binary files /dev/null and b/assets/cellarr.png differ diff --git a/assets/cellarr.svg b/assets/cellarr.svg new file mode 100644 index 0000000..73d7958 --- /dev/null +++ b/assets/cellarr.svg @@ -0,0 +1 @@ + diff --git a/docs/tutorial.md b/docs/tutorial.md index e20f8f2..f4c607b 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -58,6 +58,8 @@ some genes are unmeasured or ordered differently in the original experiments. Check out the [reference](https://biocpy.github.io/cellarr/api/cellarr#module-cellarr.build_cellarrdataset) documentation for modifying the parameters for any of these steps. ::: +![`CellArrDataset` structure](../assets/cellarr.png "CellArrDataset") + First lets mock a few `AnnData` objects: ```{code-cell}