We are happy that you are willing to help us out with the development of xpose. Before get started please take some time to read the following guidelines.
Before posting a new issue, please check that it has not already been posted.
For feature requests make sure to include sufficient information, such as a proposed workflow, plots images, links to posters or publications describing a method, etc.
For reporting a bug, the most important thing is to include a minimal reproducible example so that we can quickly verify your problem, and figure out how to fix it. To make your example reproducible:
save(xpdb, "xpdb_error.Rdata")). Note, you can use the arguments
xpose_data()to reduce the size of the xpdb whenever needed.
To contribute code to xpose please carefully follow the steps listed below.
Note 1: before getting started with a pull request, we strongly encourage you follow the procedure described above for feature requests and/or reporting a bug to ensure that your project is compatible with the our xpose road-map.
Note 2: if you are unfamiliar with the development of R packages, please take some time to read the R packages book by Hadley Wickham.
Fork the xpose repository.
Make the changes to the code on your fork.
#' @keywords internal. Add examples to new functions. Make sure to update the documentation with
devtools::document()before submitting the pull request.
xplot_qq(). Check for example the code of R/plot_gof.R to see how it should be done.
@<your_github_username>). e.g. `* Added support for multiple pages plots (@guiastrennec)
. In addition, if your pull request addresses one or several issues, please reference them using the # sign e.g.* Added support for multiple pages plots (@guiastrennec, #3)`
devtools::check() on your fork and ensure the absence of any errors, warnings and notes.
Create a pull request to the dev branch of the UUPharmacometrics/xpose repository.
Address all comments until the pull request is either merged or closed.
All of this may seem complicated at first, but you can contact one of the core developers to assist you throughout the process.