Adds packagedown website and frequency bands in the data

Author: NRaillard

.Rbuildignore

@@ -6,4 +6,7 @@
 ^data-raw$
 ^dev$
 ^devtools_history\.R$
-^\.github$
+^\.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/.gitignore

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

.github/workflows/pkgdown.yaml

@@ -0,0 +1,49 @@
+# 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:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+permissions: read-all
+
+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@v4
+
+      - 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::.
+          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/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -5,3 +5,4 @@ resourcecodedata.Rproj
 .httr-oauth
 .DS_Store
 .quarto
+docs

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: resourcecodedata
 Title: Data package with the Resourcecode database configuration data
-Version: 0.2.0
+Version: 1.0.0
 Authors@R: 
     person("Nicolas", "Raillard", , "nicolas.raillard@ifremer.fr", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-3385-5104"))
@@ -13,8 +13,7 @@ Description: Includes Resourcecode hindcast database (see
     regional sources and co-funding by the European Union's Horizon 2020
     research and innovation program.
 License: GPL (>= 3)
-URL: https://github.com/Resourcecode-project/r-resourcecodedata
-    https://resourcecode-project.r-universe.dev/resourcecodedata
+URL: https://github.com/Resourcecode-project/r-resourcecodedata, https://resourcecode-project.r-universe.dev/resourcecodedata, https://resourcecode-project.github.io/r-resourcecodedata, https://resourcecode-project.github.io/r-resourcecodedata/
 BugReports: 
     https://github.com/Resourcecode-project/r-resourcecodedata/issues
 Depends: 

R/data.R

@@ -89,7 +89,7 @@
 #' <https://archimer.ifremer.fr/doc/00751/86306/>
 "rscd_triangles"
 
-#' Resourcecode frequency vector of 1D and 2D spectra
+#' Resourcecode central frequency vector of 1D and 2D spectra
 #'
 #' The wave spectrum discretization considers 36 frequencies, starting from
 #' 0.0339 Hz up to 0.9526 Hz with a frequency increment factor of 1.1
@@ -100,6 +100,28 @@
 #' <https://archimer.ifremer.fr/doc/00751/86306/>
 "rscd_freq"
 
+#' Resourcecode lower frequency vector of 1D and 2D spectra
+#'
+#' The wave spectrum discretization considers 36 frequencies, starting from
+#' 0.0339 Hz up to 0.9526 Hz with a frequency increment factor of 1.1
+#'
+#' @format A vector 36 elements with the frequencies values
+#'
+#' @source User Manual of the RESOURCECODE database
+#' <https://archimer.ifremer.fr/doc/00751/86306/>
+"rscd_frequency1"
+
+#' Resourcecode higher frequency vector of 1D and 2D spectra
+#'
+#' The wave spectrum discretization considers 36 frequencies, starting from
+#' 0.0339 Hz up to 0.9526 Hz with a frequency increment factor of 1.1
+#'
+#' @format A vector 36 elements with the frequencies values
+#'
+#' @source User Manual of the RESOURCECODE database
+#' <https://archimer.ifremer.fr/doc/00751/86306/>
+"rscd_frequency2"
+
 #' Resourcecode directional bins
 #'
 # In terms of directional discretization, 36 directions were used

README.Rmd

@@ -16,8 +16,8 @@ knitr::opts_chunk$set(
 
 # resourcecodedata
 
-This a data-only R package. It contains the **Resourcecode** hindcast database configuration data:
-nodes locations for both the sea-state parameters, examples of time series of 1D and 2D surface elevation variance spectral density, etc.
+This a data-only R package. It contains the **Resourcecode** hindcast database configuration data, that is used to run the WWIIIⓇ model:
+nodes locations for both the sea-state parameters, examples of time series of 1D and 2D surface elevation variance spectral density, etc. These are static data that will **never** be updated.
 
 For more on using these data, see the GitHub repository for the [resourcecode](https://github.com/Resourcecode-project/r-resourcecode) package, which is built to interact with data in this package.
 

README.md

@@ -4,9 +4,10 @@
 # resourcecodedata
 
 This a data-only R package. It contains the **Resourcecode** hindcast
-database configuration data: nodes locations for both the sea-state
-parameters, examples of time series of 1D and 2D surface elevation
-variance spectral density, etc.
+database configuration data, that is used to run the WWIIIⓇ model: nodes
+locations for both the sea-state parameters, examples of time series of
+1D and 2D surface elevation variance spectral density, etc. These are
+static data that will **never** be updated.
 
 For more on using these data, see the GitHub repository for the
 [resourcecode](https://github.com/Resourcecode-project/r-resourcecode)

_pkgdown.yml

@@ -0,0 +1,4 @@
+url: https://resourcecode-project.github.io/r-resourcecodedata/
+template:
+  bootstrap: 5
+