Metadata-Version: 2.4
Name: scomv
Version: 0.1.0
Summary: Spatial omics analysis tools for cell/gene clustering from a standard region
Author-email: Ryosuke Nomura <nomubare123@g.ecc.u-tokyo.ac.jp>
Maintainer-email: Ryosuke Nomura <nomubare123@g.ecc.u-tokyo.ac.jp>
License: MIT
Project-URL: bugs, https://github.com/RyosukeNomural/scomv/issues
Project-URL: changelog, https://github.com/RyosukeNomural/scomv/blob/master/changelog.md
Project-URL: homepage, https://github.com/RyosukeNomural/scomv
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: adjustText
Requires-Dist: anndata==0.10.5.post1
Requires-Dist: dask==2024.8.0
Requires-Dist: dask-expr==1.1.10
Requires-Dist: fsspec==2023.6.0
Requires-Dist: geopandas==1.0.1
Requires-Dist: matplotlib
Requires-Dist: numcodecs==0.12.1
Requires-Dist: numpy==1.26.4
Requires-Dist: ome-zarr==0.10.2
Requires-Dist: opencv-python==4.11.0.86
Requires-Dist: pandas==2.3.0
Requires-Dist: plotly
Requires-Dist: pyogrio==0.11.0
Requires-Dist: scanpy==1.11.3
Requires-Dist: scikit-bio==0.7.0
Requires-Dist: scikit-learn==1.7.2
Requires-Dist: scipy==1.11.4
Requires-Dist: seaborn
Requires-Dist: shapely==2.0.7
Requires-Dist: spatialdata==0.2.5.post0
Requires-Dist: squidpy==1.6.1
Requires-Dist: stlearn==1.2.2
Requires-Dist: tblib==3.1.0
Requires-Dist: tensorboard==2.17.1
Requires-Dist: tensorboard-data-server==0.7.2
Requires-Dist: tensorflow==2.17.1
Requires-Dist: tensorflow-io-gcs-filesystem==0.37.1
Requires-Dist: tifffile==2024.8.30
Requires-Dist: tqdm
Requires-Dist: typer
Requires-Dist: xarray==2024.7.0
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: ruff; extra == "test"
Requires-Dist: ty; extra == "test"
Requires-Dist: ipdb; extra == "test"
Dynamic: license-file

# SpatialCompassV
<p align="left">
  <img
    src="https://raw.githubusercontent.com/RyosukeNomural/SpatialCompassV/main/images/logo.png"
    width="370"
    height="145"
    alt="SCOMV logo"
  />
</p>

![PyPI version](https://img.shields.io/pypi/v/scomv.svg?cacheSeconds=3600)
[![Documentation Status](https://readthedocs.org/projects/spatialcompassv/badge/?version=latest)](https://spatialcompassv.readthedocs.io/en/latest/?badge=latest)


Spatial omics analysis tools for cell/gene clustering from a astandard region

* PyPI package: https://pypi.org/project/scomv/
* Free software: MIT License
* Documentation: https://spatialcompassv.readthedocs.io


## Overview of the SpatialCompassV (SCOMV) Workflow

The overall workflow of **SpatialCompassV (SCOMV)** is summarized as follows:

- **Extraction of a reference region**  
  A reference region (e.g., a tumor region) is identified using the **[SpatialKnifeY (SKNY)](https://github.com/shusakai/skny)** algorithm.

### Vector construction from spatial grids

<table border="0" style="border-collapse: collapse; border: none;">
  <tr>
    <td style="vertical-align: top; padding-right: 14px; border: none;">
      The AnnData object is discretized into spatial grids, and for each grid,
      the shortest-distance vector to the reference region is computed.
    </td>
    <td style="vertical-align: top; width: 200px; border: none;">
      <img width="200" alt="vector"
           src="https://raw.githubusercontent.com/RyosukeNomural/SpatialCompassV/main/images/vector.png" />
    </td>
  </tr>
</table>

<table border="0" style="border-collapse: collapse; border: none;">
  <tr>
    <td style="vertical-align: top; padding-right: 14px; border: none;">
      This vector information is stored for each cell/gene and projected onto a
      <b>polar coordinate map</b>.
      The horizontal axis represents distance, and the vertical axis also represents distance. 
      Distances are defined as negative for locations inside the reference region.
    </td>
    <td style="vertical-align: top; border: none;">
        <img
          alt="polar_map"
          src="https://raw.githubusercontent.com/RyosukeNomural/SpatialCompassV/main/images/polar.png"
          style="width:400px; height:auto; display:block;"
        />
    </td>
  </tr>
</table>


<table border="0" style="border-collapse: collapse; border: none;">
  <tr>
    <td style="vertical-align: top; padding-right: 14px; border: none;">
      A <b>similarity matrix</b> is then constructed, followed by <b>PCoA and clustering</b>,
      to classify spatial distribution patterns.
    </td>
    <td style="vertical-align: top; border: none;">
      <img
        alt="PCoA"
        src="https://raw.githubusercontent.com/RyosukeNomural/SpatialCompassV/main/images/pcoa.png"
        style="width:600px; height:auto; display:block;"
        />
    </td>
  </tr>
</table>



- **Integration across multiple fields of view**  
  By integrating results from multiple regions of interest, clustering of the reference region itself (e.g., tumor malignancy states) can be performed.  
  - Gene-wise contributions are calculated using **PCA**, enabling the identification of **spatially differentially expressed genes (Spatial DEGs)**.

### Additional functionality
- Gene distributions can also be visualized as **3D density maps**, allowing direct comparison of the spatial distributions of two genes.
<p>
  <img src="https://raw.githubusercontent.com/RyosukeNomural/SpatialCompassV/main/images/overview.png"
       alt="overview"
       width="700"/>
</p>





## Credits

This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
>>>>>>> 79d3344 (Initial commit (cookiecutter-scientific-python))
