magpie-ea / magpie-modules

the reusable front-end bits in the _magpie modules
MIT License
7 stars 1 forks source link

Confusion with name, trial_type and variable of a view object #41

Closed JannisBush closed 5 years ago

JannisBush commented 5 years ago

In views_seq you need the variable name of a view object and in progress_bar you need the name you passed at creation time. The trial_type information gets submitted.

We should make clear what the difference between them is and when to use what. This could be confusing to the user. Maybe we should even try to eliminate one of them.

I see that one might want too have several view objects (different data and name) to be of the same trial_type. But couldn't we just use the name of that view object? If the user wants to group two different view objects in his analysis, he can easily do this with an or statement and the two names.

If I understand it correctly the name is currently more or less used as an id, but we do not enforce that all names are unique. This would also be important for the findViewByName()-function #25

JannisBush commented 5 years ago

Since 0.1.0 we do not use trial_type anymore and for the progress_bar users should just use view.name. Therefore, the only thing we should still do, is to tell users to use unique names (or to enforce it by a check)