templateflow / python-client

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

Track utilization: downloads, uses, etc. #68

Open oesteban opened 3 years ago

oesteban commented 3 years ago

Maybe using eTelemetry?

The idea is to be able to provide template posters with statistics about the utilization of their templates. Therefore, we could track individual file downloads and also overall uses of a given template. WDYT @mgxd @effigies ?

One problem general-purpose (as opposed to study-specific) template developers face is that they need to support the utilization of their work when requesting funding. It'd be nice to be able to provide them with more figures other than citations.

Also, it would allow us to create some sort of dashboard informing the community about the utilization of templates and provide funding agencies with more context (i.e., a template has been used 100 times by 20 users - is that popular or not?)

oesteban commented 5 months ago

Hey @mgxd, this would be a fantastic use case for migas - do you think we could adapt?

mgxd commented 5 months ago

We'd have to do some tweaking, as migas was designed with end-user tools in mind over middleware. Do you have any ideas on how this would work - would we simply have a counter per file downloaded (or just returned if it's cached?) by get()?

We might be able to at least leverage information saved by S3 - this was also discussed in re: openneuro (pinging @rwblair). This would lose out on the datalad usage though.