Fix typos in the documentation using spell_check()

Author: NRaillard

DESCRIPTION

@@ -1,29 +1,26 @@
 Package: resourcecodedata
-Title: Data package with the Resourcecode database configuration data
+Title: Resourcecode Database Configuration Data
 Version: 1.0.0
 Authors@R: 
     person("Nicolas", "Raillard", , "nicolas.raillard@ifremer.fr", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-3385-5104"))
 Description: Includes Resourcecode hindcast database (see
     <https://resourcecode.ifremer.fr>) configuration data: nodes locations
-    for both the sea-state parameters and the spectra data; and examples
-    of time series of 1D and 2D surface elevation variance spectral
-    density, etc.  This work was supported in part under the framework of
-    the OCEANERA-NET COFUND project, with funding provided by national and
-    regional sources and co-funding by the European Union's Horizon 2020
-    research and innovation program.
+    for both the sea-state parameters and the spectra data; examples of
+    time series of 1D and 2D surface elevation variance spectral density;
+    summary statistics of sea-states.
 License: GPL (>= 3)
-URL: https://github.com/Resourcecode-project/r-resourcecodedata,
-    https://resourcecode-project.r-universe.dev/resourcecodedata,
-    https://resourcecode-project.github.io/r-resourcecodedata,
+URL: https://github.com/Resourcecode-project/r-resourcecodedata/,
+    https://resourcecode-project.r-universe.dev/resourcecodedata/,
     https://resourcecode-project.github.io/r-resourcecodedata/
 BugReports: 
     https://github.com/Resourcecode-project/r-resourcecodedata/issues
 Depends: 
     R (>= 3.5)
 Encoding: UTF-8
+Language: en-GB
 LazyData: true
-LazyDataCompression: bzip2
+LazyDataCompression: xz
 NeedsCompilation: no
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2

NEWS.md

@@ -1,3 +1,8 @@
+# resourcecodedata 1.0.0
+
+- Add the upper and lower frequency for both 1D and 2D spectra.
+- Switch to version 1 to reflect the stability of the data provided by this package.
+
 # resourcecodedata 0.2.0
 
 Add statistics computed on the FIELD grid, on the whole period of time. See `?rscd_stats`

R/data.R

@@ -48,7 +48,7 @@
 #' Resourcecode coastline
 #'
 #' This data contains the coastline used to run the RESOURCECODE hindcast.
-#' This will be mainly used for ploting purpose.
+#' This will be mainly used for plotting purpose.
 #'
 #' @format A data frame with 24403 rows and 3 columns:
 #' \describe{
@@ -63,7 +63,7 @@
 #'
 #' This data contains the coastline of the islands used to run the
 #' RESOURCECODE hindcast, as data separated from the mainland.
-#' This will be mainly used for ploting purpose.
+#' This will be mainly used for plotting purpose.
 #'
 #' @format A data frame with 24403 rows and 3 columns:
 #' \describe{
@@ -78,7 +78,7 @@
 #' Resourcecode triangles
 #'
 #' This data contains the triangles of the unstructured computational mesh.
-#' This will be mainly used for ploting purpose.
+#' This will be mainly used for plotting purpose.
 #'
 #' @format A matrix with 3 rows and 566506 columns:
 #' \describe{
@@ -127,7 +127,7 @@
 # In terms of directional discretization, 36 directions were used
 #' (equivalent to a directional resolution of 10°;
 #'
-#' @format A vector of length 36 with the directionnal bins
+#' @format A vector of length 36 with the directional bins
 #'
 #' @source User Manual of the RESOURCECODE database
 #' <https://archimer.ifremer.fr/doc/00751/86306/>
@@ -179,7 +179,7 @@
 #' Resourcecode 2D directional wave spectra
 #'
 #  Example of 2D directional spectral data.
-#' This data contains the time series of 1D wave spectral
+#' This data contains the time series of 2D wave spectral
 #' data at the 'Pierre noires (6200069) wave buoy from
 #' 01-01-1994 to 31-01-1994.
 #'
@@ -195,7 +195,7 @@
 #'   \item{sth1m}{Mean directional spreading from first spectral moment}
 #'   \item{sth2m}{Mean directional spreading from second spectral moment}
 #'   \item{freq}{Central frequency}
-#'   \item{dir}{Directionnal bins}
+#'   \item{dir}{Directional bins}
 #'   \item{forcings}{A data.frame with 6 variables:
 #'    \describe{
 #'      \item{time}{Time}
@@ -220,7 +220,7 @@
 #' @format A data.frame with columns:
 #' \describe{
 #'   \item{hs_mean}{Mean significant wave height}
-#'   \item{hs_max}{Maximal modeled significant wave height}
+#'   \item{hs_max}{Maximal modelled significant wave height}
 #'   \item{tp_mean}{Mean peak wave period}
 #'   \item{wind_speed_mean}{Mean wind speed at 10m height}
 #'   \item{wind_speed_max}{Maximal wind speed at 10m height}
@@ -232,5 +232,5 @@
 #'  }
 #'  @source User Manual of the RESOURCECODE database
 #' <https://archimer.ifremer.fr/doc/00751/86306/> and computations
-#' made by Nicolas Raillard on original netCDF files.
+#' computed by Nicolas Raillard from original netCDF files.
 "rscd_stats"

README.Rmd

@@ -17,9 +17,9 @@ knitr::opts_chunk$set(
 # resourcecodedata
 
 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.
+nodes locations for both the sea-state parameters, examples of time series of 1D and 2D surface elevation variance spectral density and summary statistics computed on the whole covered area and time period. 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.
+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.
 
 ## Installation
 

README.md

@@ -6,17 +6,18 @@
 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
+1D and 2D surface elevation variance spectral density and summary
+statistics computed on the whole covered area and time period. 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)
+[Resourcecode](https://github.com/Resourcecode-project/r-resourcecode)
 package, which is built to interact with data in this package.
 
 ## Installation
 
 You can install the development version of `{resourcecodedata}` like so,
-thanks to the `{drat}`package:
+thanks to the `{drat}` package:
 
 ``` r
 install.packages("resourcecodedata",type = "source",repos = "resourcecode-project.github.io/drat")

cran-comments.md

@@ -3,3 +3,5 @@
 0 errors | 0 warnings | 1 note
 
 * This is a new release.
+* This is a data package that will be rarely updated.
+* `checkRdaFiles`has been used to reduce the size of the data as much as possible.

devtools_history.R

@@ -77,14 +77,16 @@ usethis::use_pkgdown_github_pages()
 
 attachment::att_amend_desc(update.config = T)
 
+devtools::spell_check()
 devtools::document()
 devtools::run_examples()
 urlchecker::url_check()
 devtools::build_readme()
+
 devtools::install()
 
+devtools::check_win_release()
 
-devtools::build()
-devtools::build(binary = T)
+devtools::release()
 
 remotes::install_github("eddelbuettel/drat")

inst/WORDLIST

@@ -0,0 +1,7 @@
+Dp
+RESOURCECODE
+Resourcecode
+WWIII
+hindcast
+netCDF
+verticies