bids-standard / bids-statsmodels-design-synthesizer

This is a prototype to explore the possibility of creating self-contained tool to perform the data aggregation necessary to jump from events.tsv files/model.json/other time series metadata to a design matrix (or an appropriate sparse precursor of the design matrix).
MIT License
0 stars 3 forks source link

shorter/consistent name? #3

Open yarikoptic opened 3 years ago

yarikoptic commented 3 years ago

It is bids-statsmodels-design-synthesizer but aggregate_stats_design.py (should not have .py since should not be relevant for CLI) ... I wonder if could be anything shorter:

thinking about may be just simple ones like

and match in name of the repo/package/CLI

leej3 commented 3 years ago

Ha, thanks for the feedback :) I was being a blend of germanic (sticking all the words together to be explicit as possible) and lazy (no clever names here!). We should put more thought into that though. The name change for the script itself was because I started suffering some confusion as to what I was importing.

In the end it turned out that cyclic dependencies with pybids would have stymied our efforts in this standalone attempt (or a very large amount of work to reimplement a lot of pybids functionality) so we are going to go with a cli tool within pybids itself. It’s here if you want to check it out: https://github.com/bids-standard/pybids/tree/add_design_aggregator

Any feedback/discussions would be very welcome. We will consider your proposed names before merging!

yarikoptic commented 3 years ago

I would then go for pybids events2model . Click ( https://click.palletsprojects.com/en/8.0.x/ ) makes it trivial to create arbitrarily nested hierarchy of commands, so probably could even become as wild as pybids events to model ;-) with eg pybids events providing listing or summary of events in the dataset