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

New easier intro notebooks #748

Open
LucaMarconato opened this issue Nov 1, 2024 · 1 comment
Open

New easier intro notebooks #748

LucaMarconato opened this issue Nov 1, 2024 · 1 comment
Labels
docs 📜 Documentation-related issues

Comments

@LucaMarconato
Copy link
Member

LucaMarconato commented Nov 1, 2024

We have received feedback that our intro notebooks "Use SpatialData with your data":

  1. I. Use SpatialData with your data: the SpatialData object
  2. II. Use SpatialData with your data: SpatialElements and tables
    are too tech heavy.

We should consider moving them to a section of notebooks targeting methods developers and make a slimmer version of them (maybe a single intro notebook?) using a biological dataset.

Any of the 5 datasets described here: #700 (comment) could be used.

@LucaMarconato LucaMarconato added the docs 📜 Documentation-related issues label Nov 1, 2024
@ckmah
Copy link

ckmah commented Nov 12, 2024

After some discussion, this might be better addressed by restructuring the tutorials and the intro notebooks will help facilitate this. We can break this down into several issues as proposed below:

Organize tutorials for easier usage

  • Problem: Currently, many tutorials require in-depth technical knowledge specific to SpatialData and related file formats.

  • Audience: people with compbio/bioinformatics background trying to do spatial analysis with downstream packages depending on SpatialData (similar to relationship between AnnData and Scanpy)

  • Goal: rewrite the part 1/part 2 tutorials so it is easier for users to get started.

Tutorial subsections

Basic

  • New easier intro notebooks #748 Getting Started: Most basic/common tasks using a single biological dataset (or subset). Explain SpatialData and SpatialElements, querying, basic reading/writing, plotting with spatialdata-plot.
    • Link out to “Technology Focus” notebooks for specific reading and visualization examples.
    • Link out to “Part 1” notebook for Zarr, OME-NGFF, partial write element now moved under Advanced.
    • Link to "Part 2" for advanced creation and annotation of SpatialElements.
  • New docs section: how to integrate spatialdata in your tool #751

Technology Focus

  • current technology focus notebooks listed under “Visualization”

Advanced

  • most of current tutorial notebooks 😅

@quentinblampey quentinblampey moved this to 🏗️ In Progress in Basel Hackathon Nov 2024 Nov 13, 2024
@quentinblampey quentinblampey moved this from 🏗️ In Progress to 👀 In review in Basel Hackathon Nov 2024 Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs 📜 Documentation-related issues
Projects
Status: 👀 In review
Development

No branches or pull requests

2 participants