dev.Rmd

---
title: "Technická dokumentace"
output: html_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, message = FALSE, warning = FALSE)
cnf <- config::get()
names(cnf) <- paste0("c_", names(cnf))
list2env(cnf, envir = .GlobalEnv)
```

## Struktura a nástroje

### Co se děje

- Na vstupu je 
  - online data Státní pokladny (pro část o veřejných výdajích)
  - online excelová tabulka projektů od MMR - pro validaci
  - sestavy projektů od MMR - pro validaci
  - data ze studie z roku 2017
- Na výstupu je
  - několik exportních souborů (excel, CSV, parquet)
  - webová dokumentace
  - codebook
  - studie v Rmarkdown
- Mezi tím je spousta kroků v `tidyverse`, které všechna data propojují.

### Jak se to děje

Celý pipeline je organizován nástrojem `{targets}`, funguje podobně jako `make`. Ve skriptu `_targets.R` jsou popsány všechny výstupy ("targets") a jejich vztahy. `{targets}` sleduje, které targets neodpovídají aktuálnímu stavu kódu (funkce ve skriptech v `R/`) a jeho vstupů a po spuštění pipeline (`tar_make()`) spouští pouze ten kód, který je potřeba pro uvedení výstupů do aktuální podoby. Mezi výstupy patří průběžné datasety, výstupní datové soubory i výstupní datovádokumentace.

Všechny cesty ke vstupním a výstupním souborům a dalším parametry se nastavují v `config.yml`.

O reprodukovatelnost prostředí (tj. udržování správné verze balíků R) se stará systém `{renv}`.

Dokumentaci a validaci dat zajišťují postupy s využitím balíku `{pointblank}`

Dokumentace se generuje ze vstupních Rmarkdown souborů do adresáře `/docs`, který se po push na github automaticky publikuje.

## Jak to znovu pustit

1. pustit `renv::restore()` - tím se do projektu načtou správné verze Rkových balíků
1. vložit aktualizované vstupní sestavy do `data-input/sestavy [datum]`
1. Zanést cestu do patřičného parametru v `config.yml`
1. Zopakovat s daty PRV v `data-input/prv`
1. Analogicky lze aktualizovat i excelové soubory
1. V `config.yml` aktualizovat cestu k veřejnému seznamu operací na webu dotaceeu.cz
1. Pustit `targets::tar_make()`, popř. spustit skript `build.R` nebo použít tlačítko `Build` na záložce `Build`.

## Dokumentace pro reprodukovatelnost

### Konfigurace

```{details, tooltip = "Rozbalit obsah souboru config.yml"}
"./config.yml"
```

### Prostředí

#### R

```{details, tooltip = "Rozbalit výstup sessionInfo()"}
sessionInfo()
```

#### Obsah renv.lock

```{details, tooltip = "Rozbalit obsah souboru renv.lock"}
"./renv.lock"
```


### targets: zobrazení pipeline

```{r}
targets::tar_visnetwork()
```

### Git

Repozitář online: `r c_repo_remote`

Commit: `r gert::git_info()$commit`