In this task the open suggestions for improvement of the readme file to get started with "challengeR" toolkit will be described.
- There are two readme-s, it is confusing witch one should be used.
- For some sections (Load data, perform ranking, perform bootstraping) may be helpful to provide customize scripts with different options.
- Troubleshooting section?
As it is not required to used certain software (R studio, MikText), but there are some issues appearing when using specific software, we would suggest to add a troubleshooting section to clarify such issues, e.g.:
- Specific Rstudio (e.g.: installation section)
-> devtools::install_github("wiesenfa/challengeR", dependencies = TRUE) output: WARNING: Rtools is required to build R packages, but is not currently installed. Rtools was installed via a separate executable: https://cran.r-project.org/bin/windows/Rtools/
-> installation of other packets (e.g.: glue)
- MikText: issue generating the report