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

food of thought: potential improvements of documentation to get started with esqlabsR #734

Open
SoFiHo05 opened this issue Oct 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation prio: high

Comments

@SoFiHo05
Copy link

This is a collection of questions I had when doing the get-started and using the package for the first time for my project

  • For all the Excel files, there are so many columns. Maybe one could have documentation (as there is for functions) that states which columns must be defined, which are optional, and which will take the information from the PKSim/MoBi file if one does not add information.
  • in 2. Design Scenarios: " A scenario is defined by the simulation file containing the model structure, parametrization of the model, application protocol, and (optionally) the physiology of the simulated individual or population." -> I probably would add PKSim/MoBi to specify the simulation file
  • in 2. Design Scenarios: "If you want to run the simulation with the settings as it has been exported from PK-Sim or MoBi, you can proceed to vignette("esqlabsR-run-simulations")." -> This links a bit to my first point that it was not clear to me what from this number of files and options is needed in the simplest case. This sentence is bit hidden, but for me, it was super helpful to see how easily I can run my model (from my own project where the excel sheets are not pre-filled) and get the plots in the correct format.
  • the whole DataCombine stuff is a bit unclear to me, which makes it a bit harder to understand how the plotting works. and therefore, my following comment might be more related to that than to the documentation itself
    -> How do I get the right "dataSet" entry for the plotting file? (I did figure it out eventually, but it was not obvious to me)

I hope it's helpful

@PavelBal PavelBal added documentation Improvements or additions to documentation prio: high labels Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation prio: high
Projects
None yet
Development

No branches or pull requests

2 participants