scverse / scverse/spatialdata-plot

Adding plotting specific documentation

Offen
#463 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation spatialproteomics
Vorherrschende Sprache
Python
Sterne
86
Forks
21
Ø Merge
14 Std. 50 Min.
Gemergte PRs (30 T.)
3

Beschreibung

Comment originally from @MeyerBender, thanks for the feedback!

documentation: in general, I think it would be good to have one or two notebooks that exclusively focus on visualization. Right now, it is very hard to find this in the spatialdata docs. Maybe something similar to this, which shows off the most important plotting functions in spatialproteomics.

Currently we have plotting notebooks but hidden under the "Technology-specific" section in the docs. And we have another notebook in a separate repo (=not really discoverable).

Improving the docs with a visualization-specific notebook that is easily discoverable would be valuable.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Durchsicht der Plotting-Notebooks im Abschnitt "Technology-specific" der Dokumentation und des vorhandenen spatialdata-workshops/notebooks/nb2_static_plotting.ipynb. Identifiziere die zentralen Plotting-Funktionen und wie Notebooks in der Dokumentation verlinkt sind. Als abgeschlossen gilt die Aufgabe, wenn ein auf Visualisierung ausgerichtetes Notebook in der Dokumentation von spatialdata-plot leicht auffindbar ist und die wichtigen Plotting-Funktionen abdeckt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
jupyter-notebook, python
Bereich
data-visualization, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
65/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.