Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NARPS model "group" origin #45

Open
rwblair opened this issue Dec 7, 2022 · 2 comments
Open

NARPS model "group" origin #45

rwblair opened this issue Dec 7, 2022 · 2 comments

Comments

@rwblair
Copy link
Member

rwblair commented Dec 7, 2022

Took me a minute to realize that "group" used here was coming from participants.tsv:

"GroupBy": ["contrast", "group"],

I feel like this should be made explicit some where, in model or in documentation, but I'm not sure where.

@Remi-Gau
Copy link
Contributor

Remi-Gau commented Dec 8, 2022

Technically it is mentioned explicitly: https://bids-standard.github.io/stats-models/_autosummary/bsmschema.models.Node.html#bsmschema-models-node

field GroupBy: List[str] [Required]
The output statistical maps received from the input node are split along unique combinations of the grouping variables and passed to the model as subsets. If empty, all inputs are passed to a single model to fit. Reserved strings include: “run”, “session”, “subject”, and “contrast”. Any metadata field may be used as a grouping variable.

So explicit but definitely not obvious.

As a half measure we could add a "Description" field to comment this, since those are allowed without invalidating the model.

@adelavega
Copy link
Contributor

I think in the accompanying notebook we can explain this, as this is an example of this behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants