|
3 | 3 | #' This data contains the location and characteristics of the 328,030 nodes |
4 | 4 | #' where the RESOURCECODE hindcast data is available |
5 | 5 | #' |
6 | | -#' @format ## `rscd_field` |
7 | | -#' A data frame with 328,030 rows and 5 columns: |
| 6 | +#' @format A data frame with 328,030 rows and 5 columns: |
8 | 7 | #' \describe{ |
9 | 8 | #' \item{node}{node number} |
10 | 9 | #' \item{longitude, latitude}{coordinates of the nodes} |
|
21 | 20 | #' This data contains the location and characteristics of the 24,276 nodes |
22 | 21 | #' where the full 2D spectral data is available in the RESOURCECODE data. |
23 | 22 | #' |
24 | | -#' @format ## `rscd_spectral` |
25 | | -#' A data frame with 24,276 rows and 5 columns: |
| 23 | +#' @format A data frame with 24,276 rows and 5 columns: |
26 | 24 | #' \describe{ |
27 | 25 | #' \item{longitude, latitude}{coordinates of the nodes} |
28 | 26 | #' \item{name}{Name of the spectral output point} |
|
37 | 35 | #' |
38 | 36 | #' This data contains the variables available in the FIELD database. |
39 | 37 | #' |
40 | | -#' @format ## `rscd_variables` |
41 | | -#' A data frame with 88 rows and 3 columns: |
| 38 | +#' @format A data frame with 88 rows and 3 columns: |
42 | 39 | #' \describe{ |
43 | 40 | #' \item{name}{short name of the variable} |
44 | 41 | #' \item{longname}{Full name} |
|
53 | 50 | #' This data contains the coastline used to run the RESOURCECODE hindcast. |
54 | 51 | #' This will be mainly used for ploting purpose. |
55 | 52 | #' |
56 | | -#' @format ## `rscd_coastline` |
57 | | -#' A data frame with 24403 rows and 3 columns: |
| 53 | +#' @format A data frame with 24403 rows and 3 columns: |
58 | 54 | #' \describe{ |
59 | 55 | #' \item{longitude,latitude}{coordinates of the border line} |
60 | 56 | #' \item{depth}{depth of the border.} |
|
69 | 65 | #' RESOURCECODE hindcast, as data separated from the mainland. |
70 | 66 | #' This will be mainly used for ploting purpose. |
71 | 67 | #' |
72 | | -#' @format ## `rscd_islands` |
73 | | -#' A data frame with 24403 rows and 3 columns: |
| 68 | +#' @format A data frame with 24403 rows and 3 columns: |
74 | 69 | #' \describe{ |
75 | 70 | #' \item{longitude,latitude}{coordinates of the border line} |
76 | 71 | #' \item{depth}{depth of the border} |
|
85 | 80 | #' This data contains the triangles of the unstructured computational mesh. |
86 | 81 | #' This will be mainly used for ploting purpose. |
87 | 82 | #' |
88 | | -#' @format ## `rscd_triangles` |
89 | | -#' A matrix with 3 rows and 566506 columns: |
| 83 | +#' @format A matrix with 3 rows and 566506 columns: |
90 | 84 | #' \describe{ |
91 | 85 | #' \item{rows}{verticies of the triangles} |
92 | 86 | #' \item{columns}{node number of each vertices} |
|
100 | 94 | #' The wave spectrum discretization considers 36 frequencies, starting from |
101 | 95 | #' 0.0339 Hz up to 0.9526 Hz with a frequency increment factor of 1.1 |
102 | 96 | #' |
103 | | -#' @format ## `rscd_freq` |
104 | | -#' An array 36 elements with the frequencies values |
| 97 | +#' @format A vector 36 elements with the frequencies values |
105 | 98 | #' |
106 | 99 | #' @source User Manual of the RESOURCECODE database |
107 | 100 | #' <https://archimer.ifremer.fr/doc/00751/86306/> |
|
112 | 105 | # In terms of directional discretization, 36 directions were used |
113 | 106 | #' (equivalent to a directional resolution of 10°; |
114 | 107 | #' |
115 | | -#' @format ## `rscd_dir` |
116 | | -#' An array of length 36 with the directionnal bins |
| 108 | +#' @format A vector of length 36 with the directionnal bins |
117 | 109 | #' |
118 | 110 | #' @source User Manual of the RESOURCECODE database |
119 | 111 | #' <https://archimer.ifremer.fr/doc/00751/86306/> |
|
126 | 118 | #' data at the 'Pierre noires (6200069) wave buoy from |
127 | 119 | #' 01-01-1994 to 31-01-1994. |
128 | 120 | #' |
129 | | -#' @format ## `rscd_1d_spectra` |
130 | | -#' A list with 12 elements: |
| 121 | +#' @format A list with 12 elements: |
131 | 122 | #' \describe{ |
132 | 123 | #' \item{longitude}{Longitude} |
133 | 124 | #' \item{latitude}{Latitude} |
|
170 | 161 | #' data at the 'Pierre noires (6200069) wave buoy from |
171 | 162 | #' 01-01-1994 to 31-01-1994. |
172 | 163 | #' |
173 | | -#' @format ## `rscd_2d_spectra` |
174 | | -#' A list with 9 elements: |
| 164 | +#' @format A list with 9 elements: |
175 | 165 | #' \describe{ |
176 | 166 | #' \item{longitude}{Longitude} |
177 | 167 | #' \item{latitude}{Latitude} |
|
199 | 189 | #' @source User Manual of the RESOURCECODE database |
200 | 190 | #' <https://archimer.ifremer.fr/doc/00751/86306/> |
201 | 191 | "rscd_2d_spectra" |
| 192 | + |
| 193 | +#' Resourcecode statistical summary |
| 194 | +#' |
| 195 | +# Example of summary statistics computed on the FIELD grid, |
| 196 | +#' on the whole period covered by the database, currently 1994-2023. |
| 197 | +#' |
| 198 | +#' @format A data.frame with columns: |
| 199 | +#' \describe{ |
| 200 | +#' \item{hs_mean}{Mean significant wave height} |
| 201 | +#' \item{hs_max}{Maximal modeled significant wave height} |
| 202 | +#' \item{tp_mean}{Mean peak wave period} |
| 203 | +#' \item{wind_speed_mean}{Mean wind speed at 10m height} |
| 204 | +#' \item{wind_speed_max}{Maximal wind speed at 10m height} |
| 205 | +#' \item{cur_speed_mean}{Mean current speed at surface} |
| 206 | +#' \item{cur_speed_max}{Maximal surface current speed at surface} |
| 207 | +#' \item{Wave_Dp_MeanDir}{Mean wave direction from Dp (direction of mean vector)} |
| 208 | +#' \item{Wind_MeanDir}{Mean wind direction at 10m height (direction of mean vector)} |
| 209 | +#' \item{Cur_MeanDir}{Mean surface current direction (direction of mean vector)} |
| 210 | +#' } |
| 211 | +#' @source User Manual of the RESOURCECODE database |
| 212 | +#' <https://archimer.ifremer.fr/doc/00751/86306/> and computations |
| 213 | +#' made by Nicolas Raillard on original netCDF files. |
| 214 | +"rscd_stats" |
0 commit comments