-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
57 lines (39 loc) · 3.27 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
---
title: "README"
output: md_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
<img src="man/figures/castle.png" width=50 align="right" />
# nybem
An `R` package for performing coastal habitat modeling.
## Package Status
[![Maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle)
[![Project Status: Active The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![packageversion](https://img.shields.io/badge/Package%20version-0.2.0-orange.svg?style=flat-square)](commits/master)
[![Last-changedate](https://img.shields.io/badge/last%20change-`r gsub('-', '--', Sys.Date())`-yellowgreen.svg)](/commits/master)
[![Licence](https://img.shields.io/badge/licence-CC0-blue.svg)](http://choosealicense.com/licenses/cc0-1.0/)
## Description
<img src="man/figures/r_logo.png" width=50 align="left" />
This package contains a collection of functions for modeling coastal habitat for ongoing USACE studies such as the New Jersey Back Bays (NJBB) and NY/NJ Harbor and Tributaries Study (HATS).
<img src="man/figures/HDQLO-03_h120.jpg" width=125 align="right" />
## Funding
Funding for development and maintenance of `nybem` has been provided by the following US Army Corps of Engineers (USACE) programs:
* [NY/NJ Harbor and Tributaries Study (HATS)](https://www.nan.usace.army.mil/Missions/Civil-Works/Projects-in-New-York/New-York-New-Jersey-Harbor-Tributaries-Focus-Area-Feasibility-Study/)
* [New Jersey Back Bays (NJBB)](https://www.nap.usace.army.mil/Missions/Civil-Works/New-Jersey-Back-Bays-Study/)
***
## Latest Updates
Check out the [NEWS](NEWS.md) for details on the latest updates.
***
## Authors
* [Michael Dougherty](mailto:Michael.P.Dougherty@usace.army.mil), Geographer, Rock Island District, U.S. Army Corps of Engineers <div itemscope itemtype="https://schema.org/Person"><a itemprop="sameAs" content="https://orcid.org/0000-0002-1465-5927" href="https://orcid.org/0000-0002-1465-5927" target="orcid.widget" rel="me noopener noreferrer" style="vertical-align:top;"> <img src="https://orcid.org/sites/default/files/images/orcid_16x16.png" style="width:1em;margin-right:.5em;" alt="ORCID iD icon">https://orcid.org/0000-0002-1465-5927</a></div>
* [Kyle McKay](mailto:Kyle.McKay@usace.army.mil), Research Civil Engineer, Engineer Research and Development Center, Environmental Laboratory, U.S. Army Corps of Engineers <div itemscope itemtype="https://schema.org/Person"><a itemprop="sameAs" content="https://orcid.org/0000-0003-2703-3841" href="https://orcid.org/0000-0002-1465-5927" target="orcid.widget" rel="me noopener noreferrer" style="vertical-align:top;"> <img src="https://orcid.org/sites/default/files/images/orcid_16x16.png" style="width:1em;margin-right:.5em;" alt="ORCID iD icon">https://orcid.org/0000-0003-2703-3841</a></div>
***
## Install
To install the `nybem` package, install from GitHub using the `remotes` package:
```{r install, eval=FALSE}
remotes::install_github(repo = "MVR-GIS/nybem")
```
## Documentation
Read the [documentation](https://mvr-gis.github.io/nybem/).
## Bug Reports
If you find any bugs using `nybem`, please open an [issue](https://github.com/MVR-GIS/nybem/issues).