IDEMSInternational / R-Instat

A statistics software package powered by R
http://r-instat.org/
GNU General Public License v3.0
38 stars 102 forks source link

The Use of the term Save #8938

Closed rachelkg closed 3 months ago

rachelkg commented 5 months ago

Hello @Patowhiz, @rdstern, @volloholic and @dannyparsons,

2024-04-17_13-34-09 2024-04-17_13-35-40

I have been writing the help and in working through the save options. I have noticed that we use the word save for two different things and I find that confusing.

  1. In the file menu we use save and save as for what I think most people understand save to mean. You save an item and then it appears in a place on your computer and you can reopen it.
  2. On the graph dialogs or table dialogs there is a Save Graph or Save table checkbox which brings up a box for you to add a name. In my understanding this stores the object in the metadata so that you can then recall it using the R Objects dialogs or save it to your computer using the Export as Image dialog.

I believe it is confusing to have these very different tasks called the same thing. When I click on the Save Graph check box and give it a name i assumed it would be saved to my computer but it is not, instead i still need to export and save it. I propose that we rename this Store so that it is clear that the object is being kept but that users don't think it has been saved.

Does this make sense? Does anyone else have thoughts on this? I feel curious whether I am the only one.

Thanks.

Rachel

volloholic commented 5 months ago

This makes sense to me and I like your solution of using the word store to resolve the confusion. @rdstern I'm happy for you to make the final decision on this

rdstern commented 5 months ago

I checked the use of Save or Store also with @Patowhiz . He has no objection, but I got the impression he didn't think it was that important. I am warming to the idea of making the change. If so: a) Whenever we add to anything anything in the data book we use the word store, not save.
So, for example with the calculator:

image

Here "Save Result" becomes "Store Result" and in the sub-dialog Save Column Position becomes just Column Position

It is a minor change, but in many dialogs and also in screens captured for the documentation and videos and help.

I suggest it simplifies the documentation and explanation of the data sheets and data books, and propose we make the changes. It is many dialogs, but easy to make.

I will use the new screens in our explanation of data books, but suggest the change is not sufficien tly important to recapture or re-record the screens for videos, nor for some of the documentation.

I would like more support, before starting this task. @N-thony what is your view?

rachelkg commented 5 months ago

Thanks to everyone for your feedback so far. Based on what people have said it sounds as though this is a valid point and important distinction, but we also want to make sure we are minimizing disruption. As such I propose that for now we add tool tips to these save items, saying something like "checking this will store this object in the data-book for further use." @rdstern perhaps you could decide exactly what the tool tips will say and specify who would add them.

Then in the documentation we make sure that we are clearly denoting this distinction. Including a page and or video about data-books in the getting started section of the moodle site. This will be based on the Help section relating to this.

We keep an eye out for this as R-Instat is used in training session and if this come up as a problem we consider other options then.

Thanks,

Rachel

N-thony commented 5 months ago

I checked the use of Save or Store also with @Patowhiz . He has no objection, but I got the impression he didn't think it was that important. I am warming to the idea of making the change. If so: a) Whenever we add to anything anything in the data book we use the word store, not save. So, for example with the calculator:

image

Here "Save Result" becomes "Store Result" and in the sub-dialog Save Column Position becomes just Column Position

It is a minor change, but in many dialogs and also in screens captured for the documentation and videos and help.

I suggest it simplifies the documentation and explanation of the data sheets and data books, and propose we make the changes. It is many dialogs, but easy to make.

I will use the new screens in our explanation of data books, but suggest the change is not sufficien tly important to recapture or re-record the screens for videos, nor for some of the documentation.

I would like more support, before starting this task. @N-thony what is your view?

@rdstern I also like the idea from @rachelkg but also I think the renaming will depend on the action done in the dialogue. For example when I look at your Calculator example it seems more about Append Column rather than Store Result and in a dialogue like Describe > One Variable > Summary we can call it Store Summary and other dialogues producing graphs for example we can call it Store Graph... image Once ready this will be a good task for @Fidel365 now his GitHub account is back.

Patowhiz commented 5 months ago

@rdstern @rachelkg I like the tooltip idea. This should help with the distinction and minimise any disruption that could affect existing R-Instat users. I also don't have any strong objections in regards to using the word "store".

rdstern commented 3 months ago

@MeSophie I am delighted you have started work on this. I also hope you will include the Calculate dialog. It was an interesting alternative by @N-thony to call it Append for the calculator, but with the use of the Position button it is sometimes not an append. It is always stored, so I'd prefer to just stick with Store. Is that ok by you @N-thony ?

@MeSophie of course I had not considered the database changes needed, so delighted that you have included that. This confirms we have a talented team on these developments.

N-thony commented 3 months ago

@MeSophie I am delighted you have started work on this. I also hope you will include the Calculate dialog. It was an interesting alternative by @N-thony to call it Append for the calculator, but with the use of the Position button it is sometimes not an append. It is always stored, so I'd prefer to just stick with Store. Is that ok by you @N-thony ?

@MeSophie of course I had not considered the database changes needed, so delighted that you have included that. This confirms we have a talented team on these developments.

@rdstern that is also okay with me