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

Minor ergonomics/usability improvements #770

Open
2 of 3 tasks
quentinblampey opened this issue Nov 8, 2024 · 2 comments
Open
2 of 3 tasks

Minor ergonomics/usability improvements #770

quentinblampey opened this issue Nov 8, 2024 · 2 comments

Comments

@quentinblampey
Copy link
Contributor

quentinblampey commented Nov 8, 2024

Here is a container for small changes regarding ergonomics (Basel Hackathon).

  • The "spatial query" tutorial could be renamed for people who don't know what is a spatial query. Maybe something like "Spatial subsampling/query of the SpatialData object"?
  • In this same tutorial, an example can be shown with a polygon query from Napari (or, at least mentioning the Polygon can be extracted via Napari + add a link to the tutorial). Otherwise, users may not know how to make this Polygon, because they don't want to create it manually, right?
  • Rename the "Visualization" section to "Technology-specific" in the tutorials
@josenimo
Copy link

I fully support this, the documentation for spatial query is inconsistent and incomplete.

Tutorial shows this:

cropped_sdata = sdata_ST8059050.query.bounding_box(
    axes=["x", "y"],
    min_coordinate=[bb_xmin, bb_ymin],
    max_coordinate=[bb_xmax, bb_ymax],
    target_coordinate_system="ST8059050",
)

cropped_sdata

But the query function is not documented. Image

Also,
https://spatialdata.scverse.org/en/stable/generated/spatialdata.bounding_box_query.html
is not currently working.. orImage

@quentinblampey
Copy link
Contributor Author

Hi @josenimo, thanks for your comment! Indeed, SpatialData.query is not documented

Regarding spatialdata.bounding_box_query, it is actually a function from spatialdata, not a method, so you should call it via spatialdata.bounding_box_query(sdata, ...) instead of sdata.bounding_box_query(...). Let me know if that works!

@quentinblampey quentinblampey moved this to 🏗️ In Progress in Basel Hackathon Nov 2024 Nov 14, 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
None yet
Projects
Status: 👀 In review
Development

No branches or pull requests

2 participants