Bijlage D Werkwijze
D.1 Achtergrond
Deze rapportage volgt eerdere rapportages op. Tot 2020 werd de rapportage als volgt opgebouwd:
- manuele download van data uit Scheldemonitor of zending van RWS
- manueel datamangement op projectschijf
- data bewerking, maken van figuren en tabellen etc met Matlab
- verweving van tekst en figuren met LaTeX en de Deltares template tot een pdf rapport. Dit rapport is in een frequentie van 1 keer per jaar verschenen.
In 2020 is besloten om deze werkwijze onder de loep te nemen, vanwege
- manuele download en datamanagement is foutgevoelig en tijdrovend.
- rapportage als webpagina doet meer recht aan het dynamische karakter van deze rapportage.
- er was behoefte aan betere afstemming met andere rapportages over de Schelde betreffende het berekenen van indicatoren voor toestanden en trends.
- Scheldemonitor heeft een webservice (wfs) in werking gebracht, waarmee data nu gemakkelijk met een script gedownloadt kunnen worden.
- Scheldemonitor heeft een online analyseplatform (Rstudio Server en R Shiny Server) in gebruik genomen. Dit is een online omgeving om R scripts te draaien en producten te publiceren.
Voor de rapportage 2020 is daarom besloten om de LaTeX template over te zetten naar Rmarkdown. Figuren werden nog gemaakt met Matlab.
Voor de 2021 rapportage wordt ook de code voor grafieken en tabellen overgezet naar R, zodat het aansluit bij de Scheldemonitor. Het doel was om scripts en methodiek af te stemmen met de T rapportages waar mogelijk, door het delen van code. Dit is gedeeltelijk gebeurd, vanwege de verschillende tijdlijnen. De huidige werkwijze voor de rapportage is:
- data wordt gedownloadt van Scheldemonitor met R script. Hiervoor is een package gemaakt. 2)De gedownloade data worden als csv bestanden opgeslagen voor consistentie tijdens het maken van de rapportage. Ze zijn hier terug te vinden.
- Verwerking van data tot rapport met R en Rmarkdown. Dit combineert code met beschrijvende tekst. De uitvoer in dit geval is een website. Ook wordt een pdf uitvoer gemaakt ter archivering.
- Voor de verwerking van data zijn R functies gemaakt, gebaseerd op de eerdere Matlab, verbeteringen zijn doorgevoerd in afstemming met RWS en Schelde in Beeld.
- Rmarkdown documenten en functie codes worden beheerd onder versiebeheer op Github.
- Het rapport wordt gepubliceerd via de Scheldemonitor.
D.2 Versies van het rapport
In ?? wordt de versie van de eerstelijnsrapportage beschreven. Een keer per jaar wordt de rapportage ververst. Eventuele bijzonderheden over deze versie staan hier ook.
D.3 Versies van de data
Er is op dit moment geen versiebeheer op de data in de Scheldemonitor. Er zal bijgehouden worden wanneer een export uit de database is gemaakt.
D.4 Versiebeheer van de code
De code en tekst van de rapportage wordt bewaard op Github onder versiebeheer.
D.5 Gebruikte software en packages
De beschrijving van de gebruikte software en packages staat in deze environment file.