Skip to content

Commit

Permalink
Merge pull request #383 from ldecicco-USGS/master
Browse files Browse the repository at this point in the history
Readme
  • Loading branch information
ldecicco-USGS authored Jul 28, 2017
2 parents b952ca7 + 0194a45 commit edd7055
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 32 deletions.
2 changes: 1 addition & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ README.md
^\.Rproj\.Rhistory
^\.Rproj\.travis.yml
^\.Rproj\appveyor.yml

CONDUCT.md

25 changes: 25 additions & 0 deletions CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments,
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant
(http:contributor-covenant.org), version 1.0.0, available at
http://contributor-covenant.org/version/1/0/0/
57 changes: 30 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,36 @@ Retrieval functions for USGS and EPA hydrologic and water quality data. For tuto

[https://owi.usgs.gov/R/dataRetrieval.html](https://owi.usgs.gov/R/dataRetrieval.html)

Installation
------------
## Package Status


|Linux|Windows| Test Coverage | USGS Status |
|----------|------------|------------|------------|
| [![travis](https://travis-ci.org/USGS-R/dataRetrieval.svg?branch=master)](https://travis-ci.org/USGS-R/dataRetrieval)|[![Build status](https://ci.appveyor.com/api/projects/status/a2kogyfplo3valdg?svg=true)](https://ci.appveyor.com/project/ldecicco-USGS/dataRetrieval)| [![Coverage Status](https://coveralls.io/repos/github/USGS-R/dataRetrieval/badge.svg?branch=master)](https://coveralls.io/github/USGS-R/dataRetrieval?branch=master)|[![status](https://img.shields.io/badge/USGS-Core-green.svg)](https://owi.usgs.gov/R/packages.html#core)|

### Current CRAN information:

|Version|Monthly Downloads|Total Downloads|
|----------|------------|------------|
|[![CRAN version](http://www.r-pkg.org/badges/version/dataRetrieval)](https://CRAN.R-project.org/package=dataRetrieval)|[![](http://cranlogs.r-pkg.org/badges/dataRetrieval)](https://CRAN.R-project.org/package=dataRetrieval)|[![](http://cranlogs.r-pkg.org/badges/grand-total/dataRetrieval)](https://CRAN.R-project.org/package=dataRetrieval)|

### Research software impact:
[![Research software impact](http://depsy.org/api/package/cran/dataRetrieval/badge.svg)](http://depsy.org/package/r/dataRetrieval)

### Reporting bugs

Please consider reporting bugs and asking questions on the Issues page:
[https://github.com/USGS-R/dataRetrieval/issues](https://github.com/USGS-R/dataRetrieval/issues)

Follow `@USGS_R` on Twitter for updates on USGS R packages:

[![Twitter Follow](https://img.shields.io/twitter/follow/USGS_R.svg?style=social&label=Follow%20USGS_R)](https://twitter.com/USGS_R)

### Code of Conduct

We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the [code of conduct](https://github.com/USGS-R/dataRetrieval/blob/master/CONDUCT.md) for more information.

## Installation

To install the dataRetrieval package, you must be using R 3.0 or greater and run the following command:

Expand All @@ -25,31 +53,6 @@ library(devtools)
install_github("USGS-R/dataRetrieval")
```

Reporting bugs
------------

Please consider reporting bugs and asking questions on the Issues page:

[https://github.com/USGS-R/dataRetrieval/issues](https://github.com/USGS-R/dataRetrieval/issues)

Follow `@USGS-R` on Twitter for updates on all USGS R packages:
[https://twitter.com/USGS_R](https://twitter.com/USGS_R)

### Current build tests:

|Linux|Windows|Test Coverage|
|----------|------------|------------|
| [![travis](https://travis-ci.org/USGS-R/dataRetrieval.svg?branch=master)](https://travis-ci.org/USGS-R/dataRetrieval)|[![Build status](https://ci.appveyor.com/api/projects/status/msanha92b500grr7?svg=true)](https://ci.appveyor.com/project/ldecicco-USGS/dataretrieval-787)|[![Coverage Status](https://coveralls.io/repos/github/USGS-R/dataRetrieval/badge.svg?branch=master)](https://coveralls.io/github/USGS-R/dataRetrieval?branch=master)|

### Current CRAN information:

|Version|Monthly Downloads|Total Downloads|
|----------|------------|------------|
|[![CRAN version](http://www.r-pkg.org/badges/version/dataRetrieval)](https://CRAN.R-project.org/package=dataRetrieval)|[![](http://cranlogs.r-pkg.org/badges/dataRetrieval)](https://CRAN.R-project.org/package=dataRetrieval)|[![](http://cranlogs.r-pkg.org/badges/grand-total/dataRetrieval)](https://CRAN.R-project.org/package=dataRetrieval)|

### Research software impact:
[![Research software impact](http://depsy.org/api/package/cran/dataRetrieval/badge.svg)](http://depsy.org/package/r/dataRetrieval)


## Disclaimer
This software is in the public domain because it contains materials that originally came from the U.S. Geological Survey, an agency of the United States Department of Interior. For more information, see the [official USGS copyright policy](https://www2.usgs.gov/visual-id/credit_usgs.html#copyright)
Expand Down
10 changes: 6 additions & 4 deletions tests/testthat/tests_userFriendly_fxns.R
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ test_that("Unit value data returns correct types", {
startDate <- "2012-07-10"
endDate <- "2012-07-17"
dd_2 <- readNWISuv(site, pCode, startDate, endDate)
expect_true(all(names(dd_2) %in% c("agency_cd","site_no",
"dateTime","X_.YSI.6136.UP._63680_00000",
"X_YSI.6136.DOWN_63680_00000","X_.YSI.6136.UP._63680_00000_cd",
"X_YSI.6136.DOWN_63680_00000_cd","tz_cd")))
expect_true(any(names(dd_2) %in% c("agency_cd","site_no",
"dateTime",
"X_63680_00000","X_63680_00000_cd",
"X_.YSI.6136.UP._63680_00000",
"X_.YSI.6136.UP._63680_00000_cd",
"tz_cd")))

noData <- readNWISuv("01196500","00010", "2016-06-15", "2016-06-15")
# expect_equal(noData$X_00010_00000[1], as.numeric(NA))
Expand Down

0 comments on commit edd7055

Please sign in to comment.