diff --git a/README.md b/README.md index 1636564..9f1d6c1 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,26 @@ Using the `remotes` package, this is easily installed via: ```r remotes::install_url("https://git.flavigny.de/christian/hateimparlament/archive/master.zip") ``` +Since the fetching and reading is very slow and depends on an internet connection, all vignettes +use `read_from_csv` to read already parsed tibbles from `.csv` files. + +That's why, if you want to build the vignettes yourself, you need to +download the source code, e.g. on Linux +``` +git clone https://git.flavigny.de/christian/hateimparlament +cd hateimparlament +``` +then start `R` and do +```r +devtools::load_all() +fetch_all(create = TRUE) +read_all() %>% repair() -> res +write_to_csv(res, create = TRUE) +``` +Then finally, do: +```r +devtools::install(build_vignettes = TRUE) +``` # Features diff --git a/vignettes/explicittopic.Rmd b/vignettes/explicittopic.Rmd index c571164..18f330d 100644 --- a/vignettes/explicittopic.Rmd +++ b/vignettes/explicittopic.Rmd @@ -1,8 +1,8 @@ --- -title: "explicittopic" +title: "Analysis of covered topics" output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{explicittopic} + %\VignetteIndexEntry{Analysis of covered topics} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8} --- diff --git a/vignettes/generalquestions.Rmd b/vignettes/generalquestions.Rmd index a2b05fc..09164f8 100644 --- a/vignettes/generalquestions.Rmd +++ b/vignettes/generalquestions.Rmd @@ -1,8 +1,8 @@ --- -title: "generalquestions" +title: "General questions" output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{generalquestions} + %\VignetteIndexEntry{General questions} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8} --- diff --git a/vignettes/interaction.Rmd b/vignettes/interaction.Rmd index 99bbfa5..2b60ddf 100644 --- a/vignettes/interaction.Rmd +++ b/vignettes/interaction.Rmd @@ -1,8 +1,8 @@ --- -title: "interaction" +title: "Interaction between fractions" output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{interaction} + %\VignetteIndexEntry{Interaction between fractions} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8} ---