Developer guide: add more about validation

Aperta
  • Qualcosa non va?
#91 1 commento 0 reazioni 1 assegnatario Vedi su GitHub

@yarikoptic ci sta già lavorando.

Dal 14/8/2023.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

ATM we have quite a lot of "heterogeneity" in how we do validation. We have multiple layers

  • pynwb

  • bidsschematools

  • nwbinspector

  • dandischema

  • dandi-cli glueing: uses above + adding more (zarr checking) - relies on content to be available, not just validation of extracted metadata

  • dandi-archive: invokes validations of dandischema, validates extracted metadata, not relying on content being present

We also have two "dataset layouts": DANDI and BIDS, with DANDI being our "ad-hoc" layout which is instrumented in code in dandi-cli.

NB We might move DANDI layout into dandischema

We have https://www.dandiarchive.org/handbook/135_validation/ which outlines to user only some, very limited, set of validations. We should get some more detailed description of "validation framework" and "DANDI layout" here.

edit: and then worth getting some meeting/presentation for DANDI team to sync our knowledge etc on all these aspects.

Lingua principale
Nessun dato sulla lingua
Stelle
6
Fork
19
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 dandi/dandi-docs

Tutte le issue di dandi/dandi-docs

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.