cliffzhou92 / STT

MIT License
11 stars 3 forks source link

User-Friendly Tutorial Added #2

Open Starlitnightly opened 1 month ago

Starlitnightly commented 1 month ago

Dear Author,

I hope this message finds you well.

We are writing to introduce you to the new tutorials we have developed for the Spatial transition Tersor (STT). Our goal was to enhance the user experience and make the toolkit more accessible to a broader audience. Below, we highlight the key improvements we've implemented:

  1. More User-Friendly Function Implementation: We have streamlined the function implementation process by eliminating unnecessary extra assignments found in the original documentation. These assignments are now automated and encapsulated within the omicverse.space.STT class, simplifying the workflow for users.

  2. Removed Version Dependencies: In the original requirements.txt, there were strong dependencies, such as CellRank==1.3.1, gseapy==1.0.4. We have removed these stringent version requirements. Now, users only need to install the OmicVerse package along with the latest version of CellRank to ensure everything works seamlessly.

  3. Added Clearer Function Notes: We recognized that some areas of the original tutorial were unclear, often requiring users to refer back to the original paper. We have reorganized these sections and provided detailed, clear notes directly in the documentation, making it easier to follow and understand without additional references.

We believe these updates will significantly improve the usability and accessibility of STT, and we are excited to share them with the community.

We would be honored if you could take the time to review our tutorials and provide any comments or suggestions you might have. Additionally, we would greatly appreciate your feedback on any possible inaccuracies in our presentation that may need modification. The tutorials can be accessed at the following link: https://starlitnightly.github.io/omicverse/Tutorials-space/t_stt/.

Thank you for your pioneering work on STT. We hope our contributions will further its impact and usability.

Best regards,

Zehua