search

AuroreAA / ICSClust

What the Package Does in One 'Title Case' Line
GNU General Public License v3.0
0 stars 0 forks source link

Documentation `runif_outside_range()` #17

Closed AuroreAA closed 1 year ago

AuroreAA commented 1 year ago 
          > For the function `runif_outside_range()` it is hard to distill how the `mult` parameter in the function affects the result. Providing the actual bounds on the values that are implied by `mult` might be easier to read, and one could leave the explanation of the method to the details.

It might be the easiest to include a figure in the help file because it's a bit cumbersome to explain in words. See here how to include a figure in a help file: https://cran.r-project.org/doc/manuals/R-exts.html#Figures

Or include examples that demonstrate this where we plot a very large sample drawn with this function with different values for mult.

Originally posted by @aalfons in https://github.com/AuroreAA/ICSClust/issues/13#issuecomment-1545664392

aalfons commented 1 year ago

I added some examples that illustrate the behavior and made other improvements to the documentation.