-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
68 lines (51 loc) · 3.36 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
<!-- badges: start -->
[](https://CRAN.R-project.org/package=SWMPrStorm) [](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/LimnoTech/SWMPrStorm/actions)
<!-- badges: end -->
<!-- logos: start -->
<img src="man/figures/swmpr_logo.png" align="center"/>
<img src="man/figures/Storm-Story-logo.png" align="center" width = "50%"/>
<!-- logos: end -->
## Overview
The System Wide Monitoring Program ([SWMP](http://nerrs.noaa.gov/RCDefault.aspx?ID=18)) was implemented by the National Estuarine Research Reserve System ([NERRS](http://nerrs.noaa.gov/)) in 1995 to provide continuous monitoring data at over 140 continuous monitoring stations in 28 estuaries across the United States. SWMPrStorm (pronounced "swamper storm") is an R package that provides functions to organize and analyze SWMP data on a storm event basis. It is a companion package to [SWMPr](https://github.com/fawda123/SWMPr) and [SWMPrExtension](https://github.com/NOAA-OCM/SWMPrExtension/). Currently, there is no citation for SWMPrStorm
## Installation
SWMPrStorm is not yet available on [CRAN](https://CRAN.R-project.org) but will be in 2022.
You can install the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("LimnoTech/SWMPrStorm")
```
## Using the Package
Documentation for SWMPrStorm is currently in development.
SWMPrStorm adds several functions to existing concepts in SWMPr and builds upon the "Reporting" concept introduced in SWMPrExtension.
### Analyze
The core analyses available within the SWMprStorm R package and used to create the StormStories report fall into two general categories: timeseries plots, summary tables, and wind roses. There is also an additional category called “mapping” which contains functions that generate the storm track map. The analyses, methods, and map in this section were selected by and approved by a technical advisory committee composed of staff from a subset of the Southeast Atlantic and Caribbean NERRs.
#### Core Analyses
<!-- haven't found a great way to remove the `\` before the `_` upon rendering -->
<table>
<tr><td><code>event_timeseries</code></td><td>Description here</td></tr>
<tr><td><code>Function #2 Name</code></td><td>Description here</td></tr>
<tr><td><code>Function #3 Name</code></td><td>Description here</td></tr>
</table>
#### Mapping
<table>
<tr><td><code>mapping function name</code></td><td>Description here</td></tr>
</table>
### Reporting
The reporting concept refers to functions that were specifically developed for use with NERRS StormStories reporting scripts that are used to generate the StormStories report. They are included as part of this package in case users find them useful for their own purposes.
<table>
<tr><td><code>helper function #1</code></td><td>Description here</td></tr>
<tr><td><code>helper function #2</code></td><td>Description here</td></tr>
</table>