Skip to content
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.

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

Add SC2Spa #113

Merged
merged 4 commits into from
Aug 1, 2023
Merged

Add SC2Spa #113

merged 4 commits into from
Aug 1, 2023

Conversation

linbuliao
Copy link
Contributor

Mandatory
Name of the tool: SC2Spa

Short description: SC2Spa is a deep learning-based tool to predict the spatial coordinates of single cells.

How does the package use scverse data structures (please describe in a few sentences): scanpy and anndata are used for preprocessing for SC2Spa. SquidPy is used to calculate Moran's I in the downstream analysis of SC2Spa.

The code is publicly available under an OSI-approved license
Yes, SC2Spa is under BSD 3-Clause license

The package provides versioned releases
Yes

The package can be installed from a standard registry (e.g. PyPI, conda-forge, bioconda) Yes, SC2Spa can be installed from PyPI

The package uses automated software tests and runs them via continuous integration (CI)
Yes

The package provides API documentation via a website or README
Yes

The package uses scverse datastructures where appropriate (i.e. AnnData, MuData or SpatialData and their modality-specific extensions)
Yes, SC2Spa uses AnnData, SCANPY and SquidPy

I am the author or maintainer of the tool and agree on listing the package on the scverse website
Yes

Recommended
I would like this package to be announced on scverse channels (zulip, discourse, twitter) [Include twitter handles you want us to tag]:
Yes, I would recommend these handles: SC2Spa, Spatial Inference, scRNA-seq, spatial transcriptomics, predict spatial coordinates, cell communication.

The package provides tutorials (or "vignettes") that help getting users started quickly
Yes, SC2Spa provides readthedocs tutorials.

The package uses the scverse cookiecutter template.
No, but I will consider adding this feature in the future

linbuliao and others added 2 commits July 27, 2023 14:09
Mandatory
Name of the tool: SC2Spa

Short description: SC2Spa is a deep learning-based tool to predict the spatial coordinates of single cells.

How does the package use scverse data structures (please describe in a few sentences):  scanpy and anndata are used for preprocessing for SC2Spa. SquidPy is used to calculate Moran's I in the downstream analysis of SC2Spa.

 The code is publicly available under an OSI-approved license
Yes, SC2Spa is under BSD 3-Clause license

 The package provides versioned releases
Yes

The package can be installed from a standard registry (e.g. PyPI, conda-forge, bioconda)
Yes, SC2Spa can be installed from PyPI

 The package uses automated software tests and runs them via continuous integration (CI)
Yes

 The package provides API documentation via a website or README
Yes

 The package uses scverse datastructures where appropriate (i.e. AnnData, MuData or SpatialData and their modality-specific extensions)
Yes, SC2Spa uses AnnData, SCANPY and SquidPy

 I am the author or maintainer of the tool and agree on listing the package on the scverse website
Yes

Recommended
 I would like this package to be announced on scverse channels (zulip, discourse, twitter) [Include twitter handles you want us to tag]:
Yes, I would recommend these handles: SC2Spa, Spatial Inference, scRNA-seq, spatial transcriptomics, predict spatial coordinates, cell communication.

 The package provides tutorials (or "vignettes") that help getting users started quickly
Yes, SC2Spa provides readthedocs tutorials.

 The package uses the scverse cookiecutter template.
No, but I will consider adding this feature in the future
@flying-sheep flying-sheep added the enhancement New feature or request label Jul 27, 2023
@flying-sheep flying-sheep changed the title Create meta.yaml Add SC2Spa Jul 27, 2023
@grst
Copy link
Contributor

grst commented Jul 31, 2023

Hi @linbuliao,

thans for submitting the package!

Overall, this looks good, but there are a few points to address to be fully compliant with our requirements:

  • In addition to uploading releases on PyPI, the respective version should be tagged in git, either using git tag or using GitHub's release feature. You don't need this for all past version but you should update this for the current version and stick to it for all future releases.
  • There's no API documentation. With that we mean a list of all public functions of the package with a link to the function documentations. In Sphinx, you can achieve this using the autodoc module. You can refer to our cookiecutter template for an example.

Minor comment (unrelated to the review checklist):

  • you may want to update your .gitignore file... dist, __pycache__, .ipynb_checkpoints, *.egg-info, etc. should not be in a git repository.

@linbuliao
Copy link
Contributor Author

Hi @grst,

Thank you for your comments! I just updated my repository according to your comemnts:

Release tags and an API documentation are added.
Irrelavant files are removed.

Best,
Linbu

Copy link
Contributor

@grst grst left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM now!

@grst grst merged commit ed34dda into scverse:main Aug 1, 2023
2 checks passed
@grst grst added the new-package PR to add a new package label Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request new-package PR to add a new package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants