BIOINF 531 HW02 - Review

Aperta
  • Qualcosa non va?
#3 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
data, documentation

Direzione di ricerca

Inizia leggendo il README e l'SRS, quindi esamina la struttura del pacchetto sorgente e la gestione descritta per FR-1.4. Determina se le aggiunte richieste al README e i vincoli di input sono definiti abbastanza bene da poter essere documentati e se le questioni relative ai valori mancanti e alla griglia spaziale richiedono una decisione del maintainer prima che il lavoro possa essere considerato completato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Hey Ninad,

I think your project is off to an incredibly impressive start; the repository structure is a masterclass in modern Python development that I’m personally learning a lot from, especially your use of tox for multi-version testing, py.typed for type safety, and the clean modularity of your src/ sub-packages. There is a creative merge of two fields here, and looking at the design documents and the repo structure, it’s clear you have a strong vision for this tool. I have a few observations from a user perspective:

  • README Clarity: While your approach is innovative and explained in great detail in the SRS, adding some of those broader details to the README would help explain the tool's purpose to a general user. For example, a specific biological "use case" (like modeling the Tumor Microenvironment) would clarify the application for those without a physics background. Additionally, providing specific examples of expected input formats would help users get started more quickly.
  • Data Integrity (FR-1.4): Regarding the handling of missing values, I wonder if "masking" incomplete cells as "unknown" rather than dropping them might better preserve spatial density. I'm concerned that dropping rows entirely could lead to losing spatial context or affecting the connectivity metrics of neighboring cells.
  • Spatial Requirements: I was also wondering about the requirement for "points on a grid." Since biological cells are often irregularly spaced, will the tool still apply to images with sparse cell density? Are there strict requirements for the spatial distribution of the input data? Defining these constraints in the README would be very helpful.

Overall, I really appreciate your far-sightedness and the professional structure of this repo. Your choice of computational tools makes the project look very robust, and I’m looking forward to seeing the progress and how the tool expands!

Lingua principale
Jupyter Notebook
Stelle
0
Fork
0
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di glotzerlab/MatSpat

Tutte le issue di glotzerlab/MatSpat

Issue simili

Altre issue su Data Engineering

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.