In the following sub-chapters three basic use cases – requiring no programming skills - and one advanced use case – requiring advanced R programming skills – are presented, in order to show how the R reporting tool can be modified.
In order to use the latest operational data (from the MySQL DB of the Haridwar site) in the R reporting tool you need to run the following code in R(Studio):
aquanes.report::run_app(use_live_data = TRUE)If also the analytical data was updated you need to save the analytics file with the filename “analytics.xlsx” at the location returned by running the following code in R(Studio):
system.file("shiny/haridwar/data/analytics.xlsx", package = "aquanes.report")In this example (which is based on the R 3.3.2 release) it will be located in your personal documents folder under: “C:/Users/YOUR_USERNAME/Documents/R/win-library/3.3/aquanes.report/shiny/haridwar/data/analytics.xlsx”
In order to use the latest analytics data in the R reporting tool you also need to run the following code in R(Studio):
aquanes.report::run_app(use_live_data = TRUE)The thresholds are defined in a CSV file, which is located at the location returned by running the following code in R(Studio):
system.file("shiny/haridwar/data/thesholds.csv", package = "aquanes.report")In this example (which is based on the R 3.3.2 release) it will be located in your personal documents folder under: “C:/Users/YOUR_USERNAME/Documents/R/win-library/3.3/aquanes.report/shiny/haridwar/data/thresholds.csv”
For updating e.g. the threshold for the parameter “Battery voltage” for example to “24”, the value in column ParameterThreshold (see Table 1) needs to be updated and saved. A threshold value for a parameter not defined in the table below can be added by typing its ParameterCode, Parameter-Name, ParameterUnit into a new line of “thresholds.csv”. For example all valid parameters values for the operational Haridwar data are defined here:
system.file("shiny/haridwar/data/operation_parameters.csv", package = "aquanes.report")In addition data entries for the columns ParameterThresholdComparison (i.e. >=, =, >=) and Pa-rameterThreshold are required, whilst ParameterThresholdSource can be freely defined by the user or even left blank. Finally the app needs to be restarted as described in Chapter 3.1.2 (in case no new operation/analytical data should be used) or in Chapter 3.1.1 (in case also new operational/analytical data should be used).
knitr::kable(x = aquanes.report::get_thresholds(), row.names = FALSE)The two maps shown in the site panel tab can be adapted. During the app start the configuration file “site_info.csv” is imported and used for specifying the:
Coordinates: longitude and latitude
Popup menu: site name, location and link
In case the user wants to change either coordinates, popup menu or both, the configuration file needs to be modified. Its location will be returned by running the following code in R(Studio):
system.file("shiny/haridwar/data/site_info.csv", package = "aquanes.report")In this example (which is based on the R 3.3.2 release) it will be located in your personal documents folder under: “C:/Users/YOUR_USERNAME/Documents/R/win-library/3.3/aquanes.report/shiny/haridwar/data/site_info.csv”
In general, adapting the R reporting tool to other sites is possible, as the R code is released using an open source MIT licence on Github and Zenodo.
However, advanced R programming techniques are required in order to adapt the importing, aggregation and calculations for another site. Thus it is planned within the AQUANES project to adapt the R reporting tool to the following five additional AQUANES sites:
Berlin-Tiefwerder (site 1)
Basel-Lange Erlen (site 6)
Agon-Countainville (site 8)
Berlin-Schönerlinde (site 12)
Packington (site 13)