Vignette (#17)

* set up vignette

* first draft of vignette

* install qpdf

* add pandoc installation

* adjust dockerfile

* fix typo

* Update vignettes/how-to-use-MapR.Rmd

Co-authored-by: Antonia Runge <antonia.runge@inwt-statistics.de>

* Update vignettes/how-to-use-MapR.Rmd

Co-authored-by: Antonia Runge <antonia.runge@inwt-statistics.de>

* Update README.md

Co-authored-by: Antonia Runge <antonia.runge@inwt-statistics.de>

* update vignette and readme

* Update README.md

Co-authored-by: Jan Abel <106665518+jan-abel-inwt@users.noreply.github.com>

* adding little structure into the vignette (#19)

* small readme fix

---------

Co-authored-by: Antonia Runge <antonia.runge@inwt-statistics.de>
Co-authored-by: Jan Abel <106665518+jan-abel-inwt@users.noreply.github.com>

.gitignore

@@ -1,2 +1,3 @@
 .Rproj.user
 .Rhistory
+inst/doc

DESCRIPTION

@@ -21,5 +21,8 @@ Imports:
     terra,
     yaml
 Suggests: 
+    knitr,
+    rmarkdown,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
+VignetteBuilder: knitr

Dockerfile

@@ -2,7 +2,11 @@ FROM inwt/r-shiny:4.2.3
 
 ADD . .
 
-RUN echo "options(repos = c(getOption('repos'), PANDORA = 'https://Pandora-IsoMemo.github.io/drat/'))" >> /usr/local/lib/R/etc/Rprofile.site \
-  && installPackage
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+    qpdf \
+    pandoc \
+    && echo "options(repos = c(getOption('repos'), PANDORA = 'https://Pandora-IsoMemo.github.io/drat/'))" >> /usr/local/lib/R/etc/Rprofile.site \
+    && installPackage
 
 CMD ["Rscript", "-e", "library(MapR);startApplication(3838)"]

README.md

@@ -3,9 +3,23 @@ An App to display temporal and temperature graphical files for Isomemo.
 
 ### Access to online versions:
 - MAIN versions:
-  - tbd 
+  - https://pandoraapp.earth/app/mapr 
 - BETA versions:
-  - Search: https://pandoraapp.earth/app/mapr-beta
+  - https://pandoraapp.earth/app/mapr-beta
 
 ### Release notes:
 - see `NEWS.md`
+
+## How to use this Package
+
+Refer to the vignette for a description of the usage of the MapR package.
+
+----
+
+### Notes for developers
+
+When adding information to _help_ sites, _docstrings_ or the _vignette_ of this package, please update documentation locally as follows:
+
+`devtools::document()` # or CTRL + SHIFT + D in RStudio
+
+`devtools::build_site()`