templateflow / python-client

A python client to query TemplateFlow via pyBIDS
https://templateflow.org/python-client/
Apache License 2.0
8 stars 10 forks source link

Feature request: list available files for a template #90

Closed nmarkowitz closed 2 years ago

nmarkowitz commented 2 years ago

Hi, I'm just starting out with templateflow and one thing I thought may be nice is to have a function that can list all available files related to that template. For example:

from templateflow import api as tflow
tflow.get_files("MNI152NLin6Asym")

It would simply list the files available to use associated with this template without first having to download everything. Maybe it can be integrated with get_metadata() or get()? Hope this is possible.

oesteban commented 2 years ago

This is definitely a good idea. I would say the API should be api.list() though - would that seem reasonable?

nmarkowitz commented 2 years ago

@oesteban that sounds great. Do you think the api.list() could accept arguments similar as api.get() to filter for different datatypes and descriptors such as mask or a T1/T2?

oesteban commented 2 years ago

Yes, I think that would be fundamental. And it's not that hard to expose because get() does need to internally list() with those filters

On Sun, May 8, 2022, 18:42 NoahMarkowitz @.***> wrote:

@oesteban https://github.com/oesteban that sounds great. Do you think the api.list() could accept arguments similar as api.get() to filter for different datatypes and descriptors such as mask or a T1/T2?

— Reply to this email directly, view it on GitHub https://github.com/templateflow/python-client/issues/90#issuecomment-1120459186, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAESDRRJBZYMBWNII6TUUSLVI74HZANCNFSM5QAI67HA . You are receiving this because you were mentioned.Message ID: @.***>