README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  eval = FALSE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

<!-- badges: start -->
[![resourcecodedata status badge](https://resourcecode-project.r-universe.dev/resourcecodedata/badges/version)](https://resourcecode-project.r-universe.dev/resourcecodedata)
[![CRAN status](https://www.r-pkg.org/badges/version/resourcecodedata)](https://CRAN.R-project.org/package=resourcecodedata)
<!-- badges: end -->

# resourcecodedata <a href="https://resourcecode-project.github.io/r-resourcecodedata/"><img src="man/figures/logo.png" align="right" height="139" alt="resourcecodedata website" /></a>

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 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.

## Installation

The package is on CRAN so can be installed simply by:

```{r}
install.packages("resourcecodedata")
```

You can also install the development version of `{resourcecodedata}`  from [r-universe](https://resourcecode-project.r-universe.dev/resourcecodedata):

```{r}
install.packages("resourcecodedata", repos = c("https://resourcecode-project.r-universe.dev", "https://cloud.r-project.org"))
```