Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tutorial examples for setParametersValue not "explicit" #1329

Closed
Laura-Villain opened this issue Nov 17, 2023 · 2 comments · Fixed by #1330
Closed

Tutorial examples for setParametersValue not "explicit" #1329

Laura-Villain opened this issue Nov 17, 2023 · 2 comments · Fixed by #1330

Comments

@Laura-Villain
Copy link
Contributor

Laura-Villain commented Nov 17, 2023

As I was following the introduction to the R package, I found two examples not "helpfull" to understand as a beginner:

image
From what I understand, we don't see any change, as the dose of 350 mg is too small to be shown in kg. However, I would suggest:

  • A first example where we can see the impact of the function
  • A comment saying why we don't see any difference

It might be also interesting to specify that it is equivalent to simply assigning a new $value
ex: doseParam$value <- toBaseUnit(doseParam, 350, "mg")

image

As the dose is set at 0.00 kg at first, the "scaling" gives us a value of still 0.00
I think it is not super explicit to understand the behavior of this function

Another remark is that I find (as a beginner) confusing to have a rounded value appear. For example, I would have expected to find something like 3.5* 10E-4 kg in the first case. If the value is rounded to 0.00 kg, then there is no way to know if we are really at 0, or just smaller than 0.01 kg.

@PavelBal
Copy link
Member

We might want to change the behavior of the print function, see ussies #1246 #1123

@Laura-Villain Feel free to propose a fix and create a pull request :)

@Laura-Villain
Copy link
Contributor Author

@PavelBal here is a suggestion: #1330

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants