search

bids-standard / stats-models

BIDS Stats Models Specification
https://bids-standard.github.io/stats-models
Other
2 stars 9 forks source link

RFC: Should software drop the outer list? #34

Closed effigies closed 2 years ago

effigies commented 2 years ago

From Model.Software

field Software: Optional[List[Dict[str, Dict[str, Any]]]] This section allows one to specify any software-specific estimation parameters. Each value in the list is an object, with the key being the name of the software package (FSL, SPM, etc.), and the value being an object containing software-specific parameters. The BIDS-Model spec makes no attempt to control the vocabulary available for use in any particular software package; we expect that the developers of each package will, over time, fill in these specifications.

Should the type instead be Optional[Dict[str, Dict[str, Any]]] and the text updated to:

This section allows one to specify any software-specific estimation parameters. Each key in the object is the name of the software package (FSL, SPM, etc.), and the value is an object containing parameters specific to that software. The BIDS-Model spec makes no attempt to control the vocabulary available for use in any particular software package; we expect that the developers of each package will, over time, fill in these specifications.

effigies commented 2 years ago

To be clear, this would change:

[
  {"FSL": {"fslparam": "val1"}},
  {"SPM": {"spmparam": "val2"}}
]

To:

{
  "FSL": {"fslparam": "val1"},
  "SPM": {"spmparam": "val2"}
}
Remi-Gau commented 2 years ago

Agreed: fewer curly braces would be good.