Fix pak error - remote repos (datatools & rgpt3) (#21)

* remove remotes - rgpt3 * update README * cleanup news.md * add r-cmd badge to readme
Pandora-IsoMemo · Jan 30, 2024 · e10f69c · e10f69c
1 parent 626ffca
commit e10f69c
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 71 deletions.
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -21,7 +21,6 @@ jobs:
           # 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: windows-latest, r: '4.1'}
           - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
           - {os: ubuntu-latest,   r: 'release'}
           - {os: ubuntu-latest,   r: 'oldrel-1'}
@@ -41,7 +40,8 @@ jobs:
           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

diff --git a/DESCRIPTION b/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),

diff --git a/NEWS.md b/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>
+    ```
diff --git a/README.md b/README.md
@@ -1,25 +1,30 @@
 # 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. You can find it in the
+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.
 
-----
-
-### Notes for developers
+## Notes for developers
 
-When adding information to _help_ sites, _docstrings_ or the _vignette_ of this package, please update documentation locally as follows:
+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.
 
 ```R
 devtools::document() # or CTRL + SHIFT + D in RStudio

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -1,4 +1,4 @@
 url: https://pandora-isomemo.github.io/MapR/
+
 template:
   bootstrap: 5
-