Skip to content

Commit c458319

Browse files
authored
Updated README
1 parent 665e2be commit c458319

1 file changed

Lines changed: 32 additions & 11 deletions

File tree

README.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
# Xenium Analysis Tools
22

3-
A Python library for processing and mapping Xenium sections using SpatialData formatting.
3+
A Python library for processing and analyzing Xenium sections, utilizing SpatialData formatting.
44

55
## Installation
66

7-
### Code Ocean Package Manager
7+
### In Code Ocean Package Manager:
88
pip: git+[https://github.com/AllenInstitute/xenium_analysis_tools#egg=xenium-analysis-tools]
9-
9+
* To get updated version of package, need to 'refresh' package image - usually removing and adding again works.
1010

1111
---
12+
## params.json
13+
Configurations for processing (folder/file names, MapMyCells parameters, options for functions, etc.)
1214

1315
## Modules
14-
1516
### 1. `process_xenium`
1617

1718
Tools for processing raw Xenium outputs, managing SpatialData objects, and preparing data for downstream analysis.
@@ -20,18 +21,38 @@ Tools for processing raw Xenium outputs, managing SpatialData objects, and prepa
2021
* **`generate_dataset_slides`**: Generate the slide-level SpatialData objects from Xenium bundles for a Xenium dataset.
2122
* **`process_dataset_slides`**: Generate the section-level SpatialData objects from slides for a Xenium dataset.
2223
#### Task-specific functions:
23-
* **`process_spatialdata`**: Core logic for manipulating and formatting Xenium `SpatialData` objects.
24-
* **`divide_sections`**: Utilities for handling section boundaries and splitting data.
25-
* **`validate_sections`**: Quality control checks to ensure section integrity before processing.
24+
* **`process_spatialdata`**: Functions for processing/formatting Xenium `SpatialData` objects.
25+
* **`divide_sections`**: Functions for dividing multi-section slides into individual sections w/independent coordinate systems.
26+
* **`validate_sections`**: Quality control checks to ensure section processed correctly.
2627

2728
### 2. `map_xenium`
2829

29-
Functions for mapping cell types to Xenium data using reference taxonomies.
30+
Tools for mapping cell types to Xenium data using reference taxonomies.
3031

3132
#### Main processing function:
32-
* **`map_dataset_sections`**: Batch processing tools to apply mapping across multiple sections in a dataset.
33-
* **`map_sections`**: Logic for mapping cell types on individual sections.
33+
* **`map_dataset_sections`**: Map multiple sections in a dataset using MapMyCells.
34+
* **`map_sections`**: Functions for mapping cell types for an individual section.
3435

3536
### 3. `utils`
3637
Shared utility functions used across the library.
37-
* **`io_utils`**: Standardized functions for loading and saving Xenium data structures.
38+
* **`io_utils`**: Functions for loading data/organizing slides/sections, etc.
39+
40+
## CO Capsules
41+
[generate_xenium_spatialdata](https://codeocean.allenneuraldynamics.org/capsule/8072328/tree)
42+
* Runs generate_dataset_slides
43+
44+
[process_xenium_spatialdata](https://codeocean.allenneuraldynamics.org/capsule/4346497/tree)
45+
* Runs process_dataset_slides
46+
47+
[map_xenium_types](https://codeocean.allenneuraldynamics.org/capsule/7531529/tree)
48+
* Runs map_dataset_sections
49+
50+
[xenium_analysis_capsule](https://codeocean.allenneuraldynamics.org/capsule/7962049/tree) (currently updating...)
51+
* Capsule with notebooks for examples of how to work with SpatialData objects, explanations of processing steps, plotting, etc.
52+
53+
## To-Dos:
54+
[ ]: Finish updating xenium_analysis_capsule
55+
56+
[ ]: Consolidate & add Xenium data QC functions and make new capsule
57+
58+
[ ]: Consolidate & add mapping evaluation/QC functions

0 commit comments

Comments
 (0)