Here we describe some general guidelines for maintenance and development of
gwloggeR is developed as part of a larger git-repository: https://github.com/DOV-Vlaanderen/groundwater-logger-validation.
So first we need to checkout this repository somewhere locally.
git checkout https://github.com/DOV-Vlaanderen/groundwater-logger-validation.git
The repository consists of 3 project roots:
./src/r which is mainly used for data analysis with R. The project file
groundwater.rproj, when opened in Rstudio, will also load
src/r/.Rprofile which will setup the environment for data analysis.
./gwloggeR is the
gwloggeR package source repository used for development and testing. Open
gwloggeR.Rproj with Rstudio.
./gwloggeR.data is a small convenience package developed for uniform data loading from the
./data/raw directory. Currently it has no explicit Rstudio project file.
Note that cross-linking of files between projects based on relative paths is allowed since all projects reside in the same repository.
Always double-check the
.Rprofile file and adjust the paths accordingly.
There is a dedicated README about testing
Before releasing a version, make sure to not only run the
testthat procedures (
T), but also the extensive analytics tests to make sure that the package results conform with past expected results (i.e. the package still operates as intended on previously analyzed data).
gwloggeR documentation is built using
roxygen2. If you are using RStudio and
roxygen2 is installed, then pressing
This command will also install
gwloggeR in the R
lib\ directory and restart R.
On each update of
gwloggeR source files, make sure to run this before committing.
gwloggeR website we use
We do not use
travis for automatic website deployment. Each time one updates files that have an impact on the website, one should manually execute the following commands:
On each update of
gwloggeR source files, make sure to run these commands before committing.
Before deployment of a new version, certain steps need to be taken.
devtools::build(path = './release/bin/win', binary = TRUE)
gh-pages branch. (This is the branch that GitHub uses as source for this
gh-pages branch to github.