Update documentation [CI]

docs/cbs_data.md

@@ -0,0 +1,53 @@
+# Documentatie voor Functies
+
+## Bestand: cbs_data.R
+
+### Functie: haal_cbs_data_op
+
+```
+Haalt data op van lokale cache of rechtstreeks van CBS.
+
+Deze functie controleert of er gegevens beschikbaar zijn in de lokale cache.
+Als de cache ingeschakeld is en gegevens beschikbaar zijn, worden deze samengevoegd.
+Als de cache leeg is, haalt de functie data rechtstreeks op van het CBS.
+
+@return Een DataFrame met gecombineerde data of data opgehaald van het CBS.
+@examples
+data <- haal_cbs_data_op()
+@export
+```
+### Functie: sla_data_lokaal_op
+
+```
+Slaat een DataFrame lokaal op als CSV-bestand.
+
+Deze functie slaat een gegeven DataFrame op als CSV-bestand op een specifieke locatie
+op het bestandssysteem. De locatie wordt bepaald door een pad in de configuratie.
+Als de directory nog niet bestaat, wordt deze aangemaakt. Bij fouten tijdens het opslaan
+wordt een foutmelding getoond.
+
+@param df DataFrame die opgeslagen moet worden.
+@param bestands_naam De naam van het bestand waaronder de data opgeslagen moet worden.
+@return Geen expliciete return waarde, output is een zij-effect: een bestand op disk.
+@examples
+sla_data_lokaal_op(mijnDataFrame, "mijnData.csv")
+@export
+```
+### Functie: haal_data_van_cbs_online
+
+```
+Haalt gegevens op van CBS en slaat deze lokaal op indien geconfigureerd.
+
+Deze functie haalt data op van het CBS voor elk jaar in een opgegeven reeks.
+De gebruiker moet een specifieke 'cbs_tabel' naam opgeven. Als deze tabelnaam niet
+wordt opgegeven of leeg is, stopt de functie met een foutmelding. Voor elk jaar
+wordt gecontroleerd of de data beschikbaar is. Zo niet, stopt de functie met een
+foutmelding. De data voor alle jaren wordt gecombineerd en eventueel lokaal
+opgeslagen als dit zo is geconfigureerd.
+
+@param cbs_tabel De naam van de CBS-tabel waaruit gegevens opgehaald moeten worden.
+@return Een DataFrame met gecombineerde data van alle opgevraagde jaren.
+@examples
+haal_data_van_cbs_online("kwb")
+@export
+```

docs/ggz_data.md

@@ -0,0 +1,33 @@
+# Documentatie voor Functies
+
+## Bestand: ggz_data.R
+
+### Functie: zoek_ggz_bestand
+
+```
+Zoekt het meest recente GGZ-bestand in een opgegeven map.
+
+Deze functie zoekt in de geconfigureerde map naar het meest recente GGZ-bestand
+op basis van een specifiek naamgevingspatroon. Als er geen bestanden worden gevonden,
+wordt een foutmelding gegeven.
+
+@return De padnaam van het meest recente GGZ-bestand.
+@examples
+bestand <- zoek_ggz_bestand()
+@export
+```
+### Functie: voeg_GGZ_data_toe
+
+```
+Voegt GGZ-data toe aan een dataset en extrapoleert ontbrekende jaren.
+
+Deze functie leest GGZ-data in vanuit het meest recente bestand in een
+geconfigureerde map. Vervolgens worden de gegevens getransformeerd naar een 
+long-formaat en ontbrekende jaren geëxtrapoleerd met lineaire regressie. De 
+verwerkte gegevens worden teruggegeven als een DataFrame.
+
+@return Een DataFrame met GGZ-data, inclusief extrapolatie voor ontbrekende jaren.
+@examples
+ggz_data <- voeg_GGZ_data_toe()
+@export
+```

docs/halte_data.md

@@ -0,0 +1,50 @@
+# Documentatie voor Functies
+
+## Bestand: halte_data.R
+
+### Functie: haal_halte_data_op
+
+```
+Haal halte data op
+
+Deze functie haalt haltegegevens op van een externe CSV-bestand, filtert op haltes die geen locatie_type 1 hebben,
+en zet de gegevens om naar een sf-object met de juiste coördinaten en CRS.
+
+@param halte_id Een unieke ID van de halte waarvan de data opgehaald wordt.
+@return Een sf-object met halte data.
+```
+### Functie: haal_grensindeling_op
+
+```
+Haal grensindeling op voor een specifiek jaar
+
+Deze functie haalt de grensindeling op voor een gegeven jaar van de CBS WFS-service.
+Het downloadt zowel gemeentelijke als wijkgegevens, controleert op fouten, en voegt de resultaten samen.
+
+@param jaar Het jaar waarvoor de grensindeling opgehaald moet worden.
+@return Een sf-object met de geometrieën en wijkcodes van de opgehaalde gebieden.
+@throws RuntimeError als de gegevens niet kunnen worden opgehaald.
+```
+### Functie: halte_data_bewerken
+
+```
+Bewerken van haltegegevens en berekening van statistieken
+
+Deze functie voegt haltegegevens toe aan de opgehaalde grensindelingen door te berekenen hoeveel haltes zich binnen elk gebied bevinden.
+Statistieken zoals de vierkantswortel, logaritme en halte-dichtheden per vierkante meter worden ook berekend. 
+
+@param grenzen Een `sf` object met de grensindelingen.
+@param halte_data Een `sf` object met haltegegevens.
+@param jaar Het jaar waarvoor de gegevens worden bewerkt.
+@return Een data.frame met grensindelingen en bijbehorende halte-statistieken per m².
+```
+### Functie: ophalen_halte_data
+
+```
+Ophalen en bewerken van haltegegevens over meerdere jaren
+
+Deze functie haalt haltegegevens op voor meerdere jaren, zoals gedefinieerd in de configuratie, en bewerkt deze samen met grensindelingen.
+De resultaten worden samengevoegd in één dataset per jaar, inclusief statistieken over haltes per vierkante meter.
+
+@return Een data.frame met gecombineerde haltegegevens en grensindelingen over meerdere jaren.
+```

docs/index.md

@@ -1,12 +1,9 @@
----
-layout: page-with-side-nav
-title: Wmo Voorspelmodel - Voorspelling Wmo gebruikers voor de komende 5 jaar
----
-# Wmo Voorspelmodel - Voorspelling Wmo gebruikers voor de komende 5 jaar
+# Index van Documentatie
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas massa libero, gravida sed pulvinar in, euismod eget nunc. 
-Quisque gravida mi massa, eget accumsan mauris ornare ac. Vivamus massa lacus, porta nec arcu sed, feugiat semper velit. 
-Vestibulum sit amet auctor tortor. Vivamus a dolor non ligula aliquam vestibulum nec eu eros. Fusce id ultricies diam. 
-Aenean sit amet ipsum eget sapien iaculis gravida et a neque. Proin nec leo gravida lectus molestie cursus. Maecenas imperdiet 
-eu sapien id congue. Quisque molestie dolor sagittis bibendum accumsan. Nam ornare sapien vitae velit posuere, vitae facilisis 
-quam rutrum. Vestibulum varius at nunc eget cursus. Aenean non scelerisque lorem.
+Hieronder vind je een klikbare lijst van alle gegenereerde Markdown-bestanden:
+
+* [cbs_data.md](cbs_data.md)
+* [ggz_data.md](ggz_data.md)
+* [halte_data.md](halte_data.md)
+* [test.md](test.md)
+* [wmoSubcat.md](wmoSubcat.md)

docs/test.md

@@ -0,0 +1,19 @@
+# Documentatie voor Functies
+
+## Bestand: test.R
+
+### Functie: Download_Wmo_Excel
+
+```
+Functie om het Excel-bestand te downloaden
+```
+### Functie: Laad_Wmo_Data
+
+```
+Functie om data uit meerdere bladen te laden
+```
+### Functie: Voeg_WmoSubcategorieen_toe
+
+```
+Functie om Wmo-subcategorieën toe te voegen
+```

docs/wmoSubcat.md

@@ -0,0 +1,51 @@
+# Documentatie voor Functies
+
+## Bestand: wmoSubcat.R
+
+### Functie: Download_Wmo_Excel
+
+```
+Downloadt een Excel-bestand van een opgegeven URL.
+
+Deze functie controleert of een Excel-bestand al lokaal aanwezig is.
+Als het bestand niet aanwezig is, wordt het gedownload van de opgegeven URL.
+
+@param url De URL van het Excel-bestand.
+@param file_path Het lokale pad waar het Excel-bestand moet worden opgeslagen.
+@return Geen expliciete returnwaarde. Het resultaat is een lokaal bestand.
+@examples
+Download_Wmo_Excel("https://example.com/wmo.xlsx", "./data/wmo.xlsx")
+@export
+```
+### Functie: Laad_Wmo_Data
+
+```
+Laadt en combineert data uit meerdere bladen van een Excel-bestand.
+
+Deze functie leest data uit specifieke bladen van een Excel-bestand
+en combineert deze in een enkele DataFrame. Voor elk blad wordt het jaartal
+toegevoegd aan de dataset.
+
+@param file_path Het pad naar het Excel-bestand.
+@param sheets Een lijst met bladen die moeten worden geladen.
+@param jaren Een vector van jaren om de data op te filteren.
+@return Een DataFrame met gecombineerde data van de opgegeven bladen.
+@examples
+data <- Laad_Wmo_Data("./data/wmo.xlsx", c("Tabel 1", "Tabel 2", "Tabel 3"), 2017:2019)
+@export
+```
+### Functie: Voeg_WmoSubcategorieen_toe
+
+```
+Voegt Wmo-subcategorieën toe aan een dataset.
+
+Deze functie laadt data met Wmo-subcategorieën uit een Excel-bestand
+en voegt deze toe aan een bestaande dataset op gemeenteniveau. Het proces
+omvat het downloaden van het Excel-bestand, het combineren van data uit
+meerdere bladen, en het koppelen op basis van gwb_code en jaartal.
+
+@return Een DataFrame met de toegevoegde Wmo-subcategorieën.
+@examples
+wmo_data <- Voeg_WmoSubcategorieen_toe()
+@export
+```