Clarify prerequisites and timing for combining single-modality NWB files into a single, multimodal NWB

オープン
  • 何か問題がありますか？
#230 コメント 11 件 リアクション 0 件 担当者 1 名 GitHub で見る

@dougollerenshaw がすでに取り組んでいます。

2026年10月20日 から。

  • #246 @dougollerenshaw による — オープン

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
領域
documentation

調査の方向性

Start with the “NWB File Naming Convention” section in data organization and the “Data Storage and Processing” page, then review related issue 229. Document when post-QC validation is complete, how failed or partially failed QC affects retention, and whether combining is automatic or manually initiated; update both passages so the workflow is consistent and unambiguous.

索引モデルが issue の本文から書いたものです。

説明

This issue is related to https://github.com/AllenNeuralDynamics/aind-software-docs/issues/229

Right now, the docs are unclear on when a combined NWB file will be created, what conditions must be met before they can be combined, and whether the process will be automated or run only on-demand.

The two most relevant passages are:

  1. The “NWB File Naming Convention” section says the following:

    When NWB files are combined together, post QC validation, they will be saved as a new derived data asset with merged, core aind-data-schema metadata files.

    But it’s not clear when the “post QC validation” stage is reached, so in practice there’s no trigger point for initiating the combining step.

  2. The “Data Storage and Processing” page says:

    Once the outputs have been QC’d, they can be combined into a final NWB file with its associated metadata.

    So again, it makes this dependent on QC being complete and it also says “can” instead of “will”, which is less definitive.

This text should be updated so that it is clear:

  • What "post-QC validation" means and when we expect this to happen. Specifically, which (if any) QC flags are allowed to be 'failed' for a dataset to be retained? And how do we know that QC is complete?
  • What happens if QC does fail, including the case where QC fails on a subset of individual modality assets
  • How the combining process is initiated. Does it always happen automatically when QC is deemed complete (i.e. it happens automatically if no human QC is required, or happens automatically after human QC is finished), or does it require some manual step to initiate the combine process?
主要言語
JavaScript
スター
1
フォーク
0
平均マージ
5日 21時間
マージ済み PR（30日）
1

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

AllenNeuralDynamics/aind-software-docs のほかの issue

AllenNeuralDynamics/aind-software-docs の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。