Skip to content

Commit

Permalink
provide CRAN install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jsta committed Mar 27, 2019
1 parent acc2355 commit f4aa7c3
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 20 deletions.
19 changes: 12 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,32 @@ knitr::opts_chunk$set(
)
```

# nhdR

[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/nhdR)](https://cran.r-project.org/package=nhdR)
[![Travis-CI Build Status](https://travis-ci.org/jsta/nhdR.svg?branch=master)](https://travis-ci.org/jsta/nhdR)
[![Codecov test coverage](https://codecov.io/gh/jsta/nhdR/branch/master/graph/badge.svg)](https://codecov.io/gh/jsta/nhdR?branch=master)
[![DOI](https://zenodo.org/badge/75339263.svg)](https://zenodo.org/badge/latestdoi/75339263)

# nhdR
<!-- # nhdR <img src="man/figures/logo.png" align="right" height=140/> -->

The goal of nhdR is to provide R tools for interacting with the [National Hydrography Dataset](https://nhd.usgs.gov/) and [NHDPlus](http://www.horizon-systems.com/nhdplus/).
Tools for querying, downloading, and networking both the [National Hydrography Dataset (NHD)](https://nhd.usgs.gov/) and [NHDPlus](http://www.horizon-systems.com/nhdplus/) datasets.

## Installation

You can install nhdR from github with:
### Stable version from CRAN

```{r, eval=FALSE}
install.packages("nhdR")
```

### or development version from GitHub

```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("jsta/nhdR")
```

This package also requires an installation of [7-zip](http://www.7-zip.org/) that can be called via the command line using `7z` or `7za.exe`.
This package also requires an installation of [7-zip](http://www.7-zip.org/) that can be called via the command line using `7z` or `7za.exe` (check if your machine is good to go with `nhdR::has_7z()`).

## Usage
### Load package
Expand Down
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,30 @@

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

# nhdR

[![Project Status: Active - The project has reached a stable, usable
state and is being actively
developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
[![Lifecycle:
stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/nhdR)](https://cran.r-project.org/package=nhdR)
[![Travis-CI Build
Status](https://travis-ci.org/jsta/nhdR.svg?branch=master)](https://travis-ci.org/jsta/nhdR)
[![Codecov test
coverage](https://codecov.io/gh/jsta/nhdR/branch/master/graph/badge.svg)](https://codecov.io/gh/jsta/nhdR?branch=master)
[![DOI](https://zenodo.org/badge/75339263.svg)](https://zenodo.org/badge/latestdoi/75339263)

The goal of nhdR is to provide R tools for interacting with the
[National Hydrography Dataset](https://nhd.usgs.gov/) and
[NHDPlus](http://www.horizon-systems.com/nhdplus/).
# nhdR

<!-- # nhdR <img src="man/figures/logo.png" align="right" height=140/> -->

Tools for querying, downloading, and networking both the [National
Hydrography Dataset (NHD)](https://nhd.usgs.gov/) and
[NHDPlus](http://www.horizon-systems.com/nhdplus/) datasets.

## Installation

You can install nhdR from github with:
### Stable version from CRAN

``` r
install.packages("nhdR")
```

### or development version from GitHub

``` r
# install.packages("devtools")
Expand All @@ -28,7 +33,8 @@ devtools::install_github("jsta/nhdR")

This package also requires an installation of
[7-zip](http://www.7-zip.org/) that can be called via the command line
using `7z` or `7za.exe`.
using `7z` or `7za.exe` (check if your machine is good to go with
`nhdR::has_7z()`).

## Usage

Expand All @@ -45,7 +51,7 @@ below for a low resolution vpu map (also `nhdR::vpu_shp`). A hi-res
version can be found
[here](http://www.horizon-systems.com/NHDPlus/NHDPlusV2_data.php).

![](man/figures/README-unnamed-chunk-3-1.png)<!-- -->
![](man/figures/README-unnamed-chunk-4-1.png)<!-- -->

``` r
# get a vpu export
Expand Down

0 comments on commit f4aa7c3

Please sign in to comment.