Skip to content

Commit edd7055

Browse files
Merge pull request #383 from ldecicco-USGS/master
Readme
2 parents b952ca7 + 0194a45 commit edd7055

File tree

4 files changed

+62
-32
lines changed

4 files changed

+62
-32
lines changed

.Rbuildignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ README.md
1616
^\.Rproj\.Rhistory
1717
^\.Rproj\.travis.yml
1818
^\.Rproj\appveyor.yml
19-
19+
CONDUCT.md
2020

CONDUCT.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, we pledge to respect all people who
4+
contribute through reporting issues, posting feature requests, updating documentation,
5+
submitting pull requests or patches, and other activities.
6+
7+
We are committed to making participation in this project a harassment-free experience for
8+
everyone, regardless of level of experience, gender, gender identity and expression,
9+
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
10+
11+
Examples of unacceptable behavior by participants include the use of sexual language or
12+
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
13+
insults, or other unprofessional conduct.
14+
15+
Project maintainers have the right and responsibility to remove, edit, or reject comments,
16+
commits, code, wiki edits, issues, and other contributions that are not aligned to this
17+
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
18+
from the project team.
19+
20+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
21+
opening an issue or contacting one or more of the project maintainers.
22+
23+
This Code of Conduct is adapted from the Contributor Covenant
24+
(http:contributor-covenant.org), version 1.0.0, available at
25+
http://contributor-covenant.org/version/1/0/0/

README.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,36 @@ Retrieval functions for USGS and EPA hydrologic and water quality data. For tuto
44

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

7-
Installation
8-
------------
7+
## Package Status
8+
9+
10+
|Linux|Windows| Test Coverage | USGS Status |
11+
|----------|------------|------------|------------|
12+
| [![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)|
13+
14+
### Current CRAN information:
15+
16+
|Version|Monthly Downloads|Total Downloads|
17+
|----------|------------|------------|
18+
|[![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)|
19+
20+
### Research software impact:
21+
[![Research software impact](http://depsy.org/api/package/cran/dataRetrieval/badge.svg)](http://depsy.org/package/r/dataRetrieval)
22+
23+
### Reporting bugs
24+
25+
Please consider reporting bugs and asking questions on the Issues page:
26+
[https://github.com/USGS-R/dataRetrieval/issues](https://github.com/USGS-R/dataRetrieval/issues)
27+
28+
Follow `@USGS_R` on Twitter for updates on USGS R packages:
29+
30+
[![Twitter Follow](https://img.shields.io/twitter/follow/USGS_R.svg?style=social&label=Follow%20USGS_R)](https://twitter.com/USGS_R)
31+
32+
### Code of Conduct
33+
34+
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.
35+
36+
## Installation
937

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

@@ -25,31 +53,6 @@ library(devtools)
2553
install_github("USGS-R/dataRetrieval")
2654
```
2755

28-
Reporting bugs
29-
------------
30-
31-
Please consider reporting bugs and asking questions on the Issues page:
32-
33-
[https://github.com/USGS-R/dataRetrieval/issues](https://github.com/USGS-R/dataRetrieval/issues)
34-
35-
Follow `@USGS-R` on Twitter for updates on all USGS R packages:
36-
[https://twitter.com/USGS_R](https://twitter.com/USGS_R)
37-
38-
### Current build tests:
39-
40-
|Linux|Windows|Test Coverage|
41-
|----------|------------|------------|
42-
| [![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)|
43-
44-
### Current CRAN information:
45-
46-
|Version|Monthly Downloads|Total Downloads|
47-
|----------|------------|------------|
48-
|[![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)|
49-
50-
### Research software impact:
51-
[![Research software impact](http://depsy.org/api/package/cran/dataRetrieval/badge.svg)](http://depsy.org/package/r/dataRetrieval)
52-
5356

5457
## Disclaimer
5558
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)

tests/testthat/tests_userFriendly_fxns.R

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,12 @@ test_that("Unit value data returns correct types", {
3535
startDate <- "2012-07-10"
3636
endDate <- "2012-07-17"
3737
dd_2 <- readNWISuv(site, pCode, startDate, endDate)
38-
expect_true(all(names(dd_2) %in% c("agency_cd","site_no",
39-
"dateTime","X_.YSI.6136.UP._63680_00000",
40-
"X_YSI.6136.DOWN_63680_00000","X_.YSI.6136.UP._63680_00000_cd",
41-
"X_YSI.6136.DOWN_63680_00000_cd","tz_cd")))
38+
expect_true(any(names(dd_2) %in% c("agency_cd","site_no",
39+
"dateTime",
40+
"X_63680_00000","X_63680_00000_cd",
41+
"X_.YSI.6136.UP._63680_00000",
42+
"X_.YSI.6136.UP._63680_00000_cd",
43+
"tz_cd")))
4244

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

0 commit comments

Comments
 (0)