IDEMSInternational / R-Instat

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

Improvements in Help file with the addition of snippets #8889

Open rdstern opened 8 months ago

rdstern commented 8 months ago

@Fidel365 the help numbers towards the bottom of this dialog are now ready for you to check and add. Most, but not all, will work in the current help. I have made a few edits in the current help file, so a few will not.

I will add more to this issue, so make this a "partially" pull request. But it will be good to merge these changes and then have a separate pull request for the rest of them. I estimate that I'm about halfway through.

I continue to work, with @rachelkg on the help file for R-Instat. This uses software called helpNdoc. The current help file with R-Instat has a problem that the software developers have just rectified - at least for our file.

This particularly affects our use of "snippets". They are entries that are repeated more than once in the file. We currently use them in 2 ways: a) The bottom keys (Ok and to To Script) are described in a table towards the bottom of the help on each dialog. That isn't repeated, but calls a single snippet. b) Some dialogs are duplicated in different places in the menu system. For example the pivot-table dialog is in the Prepare menu, in Describe and in Climatic. The help is a single snippet, rather than being repeated 3 times.

Until version 9.1 of helpNdoc, the snippets in our help were not being shown. Now they are. We will therefore be including the new help in the next release.

We would also like now to jump to the right location in the help whenever we use a dialog that is repeated. Currently we always jump to one of the instances. I am listing the multiple help numbers below. @Fidel365 has already made this adaptation for one example (Visualise). Here are the help numbers for the remaining dialogs - mainly in the prepare menu.

a0) Replace Values in Prepare > Data Frame, Confirm 47; in Climatic > Tidy data 604 a) Pivot Table - in Prepare > Check data 319; in Describe 2/3 variable - confirm 417; in Climatic > Examine/Edit data 558 b) Duplicate rows in Prepare > Check data confirm 547; in Climatic tidy data 605. c) Compare columnsin Prepare > Check data confirm 546; in Climatic examine/edit data 562 d) Non-numeric values in Prepare > Check data confirm 545; in Climatic tidy data 603 e) Boxplotin Prepare > Check data 548 In Describe > Graphs > Boxplots Confirm 436 f) One variable summarise in Prepare > Check data 550; In Describe > One Variable Confirm 410 ; In Climatic Edit Data 615 g) One variable graph in Prepare > Check data 549; In Describe > One Variable Confirm 412 ; In Climatic Edit Data 616 h) One variable graph options in Prepare > Check data 187; In Describe > One Variable Confirm 170 ; In Climatic Edit Data 623 i) One variable frequencies in Prepare > Check data 551; In Describe > One Variable Confirm 518 ; In Climatic Edit Data 617 j) One variable frequencies options in Prepare > Check data 620; In Describe > One Variable Confirm 96 ; In Climatic Edit Data 273 k) Random samples in Prepare > Column: Numeric Confirm 376; in Model Probability Distributions 31 l) Transformin Prepare > Column: Text Confirm 343; in Climastic > Tidy 606 m) Splitin Prepare > Column: Text Confirm 344; in climatic > Tidy 601 n)Generatein Prepare > Column: Dates Confirm 460 ; in Climatic > Dates 492 o) Make Date in Prepare > Column: Dates Confirm 461 ; in Climatic > Dates 493 p) Fill Date Gaps in Prepare > Column: Dates Confirm 497 ; in Climatic > Dates 357 q) Use Datein Prepare > Column: Dates Confirm 462 ; in Climatic > Dates 494 r) Stackin Prepare > Data: Reshape Confirm 57; in Climatic > Tidy 607 s) Unstack in Prepare > Data: Reshape Confirm 58 ; in Climatic > Tidy 608 t) Merge in Prepare > Data: Reshape Confirm 60 ; in Climatic > Tidy 609 u) Joining Columnssub-dialog in Prepare > Data: Reshape Confirm 51 ; in Climatic Tidy 624 v) Columns to Includesub-dialog in Prepare > Data: Reshape Confirm 154 ; in Climatic Tidy 636 w) Append in Prepare > Data: Reshape Confirm 465 ; in Climatic > Tidy 610 x) Add Keyin Prepare > Keys and Links 504 ; in Climatic > Tidy 611 y) Summarisein Describe 2/3 Variables confirm 414 ; in Climatic > Describe 408 z) Graph in Describe 2/3 Variables confirm 416 ; in Climatic > Describe 424

rdstern commented 8 months ago

Here is a second set - maybe the last? To be continued! a) Import and Tidy NetCDF file in File Confirm 393; In Climatic > File 381 b) NetCDF Options subdialog Confirm 119 ; In climatic 117 c) Calculator in Prepare menu confirm 14; in structured > circular 176 d) Calculator circular sub-dialog confirm 596; in structured > circular 677 e) Define > Circular g) Correlations in Describe > Multivariate Confirm 421; in Describe 2/3 Variables 153 in Climatic > Compare 637 h) Display and Graphics sub-dialog Confirm 188; in Describe 2/3 Variables 675 in Climatic > Compare 676