merge main into beta

.Rbuildignore

@@ -14,3 +14,7 @@
 ^\..*$
 ^\.Rproj\.user$
 ^inst/data$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,52 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          # We only test only a subset of os & r combination for non CRAN packages
+          - {os: macos-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
+          - {os: ubuntu-latest,   r: 'oldrel-2'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+          extra-repositories: https://Pandora-IsoMemo.github.io/drat/
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true

.github/workflows/pkgdown.yaml

@@ -0,0 +1,52 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: |
+            any::pkgdown
+            local::.
+          extra-repositories: |
+            https://Pandora-IsoMemo.github.io/drat/
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

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

DESCRIPTION

@@ -7,8 +7,6 @@ License: GPL (>= 3)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
-Remotes:
-  github::ben-aaron188/rgpt3
 Imports: 
     colourpicker,
     DataTools (>= 23.12.2),
@@ -26,3 +24,4 @@ Suggests:
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 VignetteBuilder: knitr
+URL: https://pandora-isomemo.github.io/MapR/

NEWS.md

@@ -1,67 +1,72 @@
-# MapR
+# MapR 24.1.1
 
-## 24.1.0
+## New Features
 
-### New Features
+Automation of Online Package Documentation via Github Action
+
+# MapR 24.1.0
+
+## New Features
 - user can fill out questionnaires and images are displayed depending on the answers
 
-## Version 23.12.1
+# MapR 23.12.1
 
-### New Features
+## New Features
 - _Import from Pandora_: 
   - display of "About" information that is associated to a selected Pandora Repository
 
-## 23.11.0
+# MapR 23.11.0
 
-### New Features
+## New Features
 - option to add and format a plot title.
 
-## Version: 23.10.1
+# MapR 23.10.1
+
+## New Features
+- option to upload zip files via the import module from `DataTools`. Enables access to 
+  files from URL, Pandora Platform, local files, and online examples
+- Example data is taken from:
 
-### New Features
-- option to upload zip files via the import module from `DataTools`. Enables access to files from
-  URL, Pandora Platform, local files, and online examples
-  - Example data is taken from: 
-    ```R
-#> Documentation for the Beyer2020 dataset
-#> 
-#> Description:
-#> 
-#>      This dataset covers the last 120k years, at intervals of 1/2 k
-#>      years, and a resolution of 0.5 degrees in latitude and longitude.
-#> 
-#> Details:
-#> 
-#>      If you use this dataset, make sure to cite the original
-#>      publication:
-#> 
-#>      Beyer, R.M., Krapp, M. & Manica, A. High-resolution terrestrial
-#>      climate, bioclimate and vegetation for the last 120,000 years. Sci
-#>      Data 7, 236 (2020). doi:doi.org/10.1038/s41597-020-0552-1
-#>      <https://doi.org/doi.org/10.1038/s41597-020-0552-1>
-#> 
-#>      The version included in 'pastclim' has the ice sheets masked, as
-#>      well as internal seas (Black and Caspian Sea) removed. The latter
-#>      are based on:
-#> 
-#>      <https://www.marineregions.org/gazetteer.php?p=details&id=4278>
-#> 
-#>      <https://www.marineregions.org/gazetteer.php?p=details&id=4282>
-#> 
-#>      As there is no reconstruction of their depth through time, modern
-#>      outlines were used for all time steps.
-#> 
-#>      Also, for bio15, the coefficient of variation was computed after
-#>      adding one to monthly estimates, and it was multiplied by 100
-#>      following <https://pubs.usgs.gov/ds/691/ds691.pdf>
-#> 
-#>      Changelog
-#> 
-#>      v1.1.0 Added monthly variables. Files can be downloaded from:
-#>      <https://zenodo.org/deposit/7062281>
-#> 
-#>      v1.0.0 Remove ice sheets and internal seas, and use correct
-#>      formula for bio15. Files can be downloaded from:
-#>      doi:doi.org/10.6084/m9.figshare.19723405.v1
-#>      <https://doi.org/doi.org/10.6084/m9.figshare.19723405.v1>
-```
+    ```
+    #> Documentation for the Beyer2020 dataset
+    #> 
+    #> Description:
+    #> 
+    #>      This dataset covers the last 120k years, at intervals of 1/2 k
+    #>      years, and a resolution of 0.5 degrees in latitude and longitude.
+    #> 
+    #> Details:
+    #> 
+    #>      If you use this dataset, make sure to cite the original
+    #>      publication:
+    #> 
+    #>      Beyer, R.M., Krapp, M. & Manica, A. High-resolution terrestrial
+    #>      climate, bioclimate and vegetation for the last 120,000 years. Sci
+    #>      Data 7, 236 (2020). doi:doi.org/10.1038/s41597-020-0552-1
+    #>      <https://doi.org/doi.org/10.1038/s41597-020-0552-1>
+    #> 
+    #>      The version included in 'pastclim' has the ice sheets masked, as
+    #>      well as internal seas (Black and Caspian Sea) removed. The latter
+    #>      are based on:
+    #> 
+    #>      <https://www.marineregions.org/gazetteer.php?p=details&id=4278>
+    #> 
+    #>      <https://www.marineregions.org/gazetteer.php?p=details&id=4282>
+    #> 
+    #>      As there is no reconstruction of their depth through time, modern
+    #>      outlines were used for all time steps.
+    #> 
+    #>      Also, for bio15, the coefficient of variation was computed after
+    #>      adding one to monthly estimates, and it was multiplied by 100
+    #>      following <https://pubs.usgs.gov/ds/691/ds691.pdf>
+    #> 
+    #>      Changelog
+    #> 
+    #>      v1.1.0 Added monthly variables. Files can be downloaded from:
+    #>      <https://zenodo.org/deposit/7062281>
+    #> 
+    #>      v1.0.0 Remove ice sheets and internal seas, and use correct
+    #>      formula for bio15. Files can be downloaded from:
+    #>      doi:doi.org/10.6084/m9.figshare.19723405.v1
+    #>      <https://doi.org/doi.org/10.6084/m9.figshare.19723405.v1>
+    ```

README.md

@@ -1,25 +1,32 @@
 # MapR
+
+<!-- badges: start -->
+[![R-CMD-check](https://github.com/Pandora-IsoMemo/MapR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Pandora-IsoMemo/MapR/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
+
 An App to display temporal and temperature graphical files for Isomemo.
 
-### Access to online versions:
-- MAIN versions:
-  - https://pandoraapp.earth/app/mapr 
-- BETA versions:
-  - https://pandoraapp.earth/app/mapr-beta
+## Access to online versions:
+- [MAIN version](https://pandoraapp.earth/app/mapr) 
+- [BETA version](https://pandoraapp.earth/app/mapr-beta)
+
+## Release notes:
 
-### 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
+Refer to the [vignette](https://pandora-isomemo.github.io/MapR/articles/how-to-use-MapR.html) 
+for a description of the usage of the MapR package. You can find it in the 
+[documentation](https://pandora-isomemo.github.io/MapR/) of this package.
 
-When adding information to _help_ sites, _docstrings_ or the _vignette_ of this package, please update documentation locally as follows:
+## Notes for developers
 
-`devtools::document()` # or CTRL + SHIFT + D in RStudio
+When adding information to the _help_ sites, _docstrings_ or the _vignette_ of this 
+package, please update documentation locally as follows. The documentation of
+the main branch is build automatically via github action.
 
-`devtools::build_site()`
+```R
+devtools::document() # or CTRL + SHIFT + D in RStudio
+devtools::build_site()
+```

_pkgdown.yml

@@ -0,0 +1,4 @@
+url: https://pandora-isomemo.github.io/MapR/
+
+template:
+  bootstrap: 5