Skip to content

Commit ab2c445

Browse files
Merge pull request #26 from ldecicco-USGS/master
Adding more communication
2 parents 7c55014 + 36c451c commit ab2c445

25 files changed

+263
-360
lines changed

.Rbuildignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
^.*\.Rproj$
2+
^\.Rproj\.user$
3+
.travis.yml
4+
images
5+
CONDUCT.md

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
src-i386
22
src-x64
3-
.Rbuildignore
43
.Rproj.user
54
.Rhistory
65
.RData

.travis.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Sample .travis.yml for R projects.
2+
#
3+
# See README.md for instructions, or for more configuration options,
4+
# see the wiki:
5+
# https://github.com/craigcitro/r-travis/wiki
6+
7+
language: r
8+
cache: packages
9+
dist: trusty
10+
11+
matrix:
12+
include:
13+
- os: linux
14+
r: release
15+
- os: linux
16+
r: devel
17+
env: R_CODECOV=true
18+
19+
addons:
20+
apt:
21+
packages:
22+
- libcurl4-openssl-dev
23+
24+
env:
25+
global:
26+
- R_BUILD_ARGS="--no-build-vignettes --no-manual"
27+
- R_CHECK_ARGS="--no-build-vignettes --no-manual --as-cran"
28+
- NOT_CRAN="true"
29+
- _R_CHECK_FORCE_SUGGESTS_=false
30+
31+
repos:
32+
CRAN: https://cran.rstudio.com
33+
GRAN: https://owi.usgs.gov/R
34+
35+
warnings_are_errors: true
36+
37+
script:
38+
- |
39+
R CMD build .
40+
travis_wait 20 R CMD check rloadest*tar.gz
41+
42+
r_github_packages:
43+
- jimhester/covr
44+
45+
after_success:
46+
- if [[ "${R_CODECOV}" ]]; then R -e 'covr::coveralls()'; fi
47+
48+
notifications:
49+
email:
50+
on_success: change
51+
on_failure: change
52+

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/

DESCRIPTION

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Package: rloadest
22
Type: Package
33
Title: River Load Estimation
4-
Version: 0.4.4
5-
Date: 2017-01-10
6-
Authors@R: c( person("Dave", "Lorenz", email = "lorenz@usgs.gov", role = "cre"),
4+
Version: 0.4.5
5+
Date: 2017-07-26
6+
Authors@R: c( person("Dave", "Lorenz", role = "cre", email = "gs-w_r_admin@usgs.gov"),
77
person("Rob", "Runkel", role = "aut"),
88
person("Laura", "De Cicco", role = "aut"),
9-
person("David", "Watkins", role = "ctb"))
10-
Maintainer: Dave Lorenz <lorenz@usgs.gov>
9+
person("David", "Watkins", role = "ctb"),
10+
person("Joseph", "Stachelek", role = "ctb"))
1111
Description: Collection of functions to make constituent load estimations
1212
based on the LOADEST program.
1313
License: CC0
@@ -26,6 +26,7 @@ Suggests:
2626
EGRET,
2727
survival,
2828
knitr
29+
BugReports: https://github.com/USGS-R/rloadest/issues
2930
LazyLoad: yes
3031
LazyData: yes
3132
RoxygenNote: 6.0.1

R/rloadest-package.R

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
#' \tabular{ll}{
44
#' Package: \tab rloadest\cr
55
#' Type: \tab Package\cr
6-
#' Version: \tab 0.4.3\cr
7-
#' Date: \tab 2015-12-03\cr
86
#' License: \tab CC0\cr
97
#' LazyLoad: \tab yes\cr
108
#' }
@@ -31,9 +29,19 @@
3129
#'
3230
#' @name rloadest-package
3331
#' @docType package
34-
#' @author Dave Lorenz \email{lorenz@@usgs.gov}
3532
#' @keywords load estimation
3633
NULL
3734
.onAttach <- function(libname, pkgname) {
38-
packageStartupMessage("Although this software program has been used by the U.S. Geological Survey (USGS), no warranty, expressed or implied, is made by the USGS or the U.S. Government as to the accuracy and functioning of the program and related program material nor shall the fact of distribution constitute any such warranty, and no responsibility is assumed by the USGS in connection therewith.")
35+
packageStartupMessage("This information is preliminary or provisional and
36+
is subject to revision. It is being provided to meet
37+
the need for timely best science. The information
38+
has not received final approval by the U.S. Geological
39+
Survey (USGS) and is provided on the condition that
40+
neither the USGS nor the U.S. Government shall be held
41+
liable for any damages resulting from the authorized
42+
or unauthorized use of the information.
43+
44+
****Orphaned Package****
45+
This package is looking for a new maintainer. For more information,
46+
see: https://owi.usgs.gov/R/packages.html#orphan")
3947
}

README.md

Lines changed: 135 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,42 @@ rloadest
33

44
USGS water science R functions for LOAD ESTimation of constituents in rivers and streams.
55

6-
##Package Installation
6+
## Package Status
7+
[![status](https://img.shields.io/badge/USGS-Orphan-red.svg)](https://owi.usgs.gov/R/packages.html#orphan)
8+
9+
This package is currently in an 'orphaned' state, and
10+
looking for a new maintainer. For more information, see:
11+
[https://owi.usgs.gov/R/packages.html#orphan](https://owi.usgs.gov/R/packages.html#orphan)
12+
13+
If you are interested in becoming the official maintainer of `rloadest`, please email gs-w_r_admin@usgs.gov.
14+
15+
In the meantime, we rely on community involvement to report and fix bugs.
16+
17+
### Current build tests:
18+
19+
|Linux|Test Coverage|
20+
|----------|------------|
21+
| [![travis](https://travis-ci.org/USGS-R/rloadest.svg?branch=master)](https://travis-ci.org/USGS-R/rloadest)|[![Coverage Status](https://coveralls.io/repos/github/USGS-R/rloadest/badge.svg?branch=master)](https://coveralls.io/github/USGS-R/rloadest?branch=master)|
22+
23+
### Reporting bugs
24+
25+
Please consider reporting bugs and asking questions on the Issues page:
26+
[https://github.com/USGS-R/rloadest/issues](https://github.com/USGS-R/rloadest/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+
33+
## Code of Conduct
34+
35+
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/rloadest/blob/master/CONDUCT.md) for more information.
36+
37+
## Package Installation
738
To install the `rloadest` package:
839

40+
USGS R Installation Instructions: [https://owi.usgs.gov/R/training-curriculum/installr/](https://owi.usgs.gov/R/training-curriculum/installr/)
41+
942
1. Install R (version 3.0 or greater) from: [https://cran.r-project.org/](https://cran.r-project.org/)
1043

1144
2. Install RStudio from: [https://www.rstudio.com/products/rstudio/download/](https://www.rstudio.com/products/rstudio/download/)
@@ -39,9 +72,108 @@ To install the `rloadest` package:
3972

4073
7. Make sure to keep your version of R up-to-date. CRAN and the USGS repository will only update packages for the most recent version of R, and one version behind that.
4174

75+
## Model Archive
76+
77+
When using the `rloadest` model, it is important to be able to reproduce the results in the future. The following version of R and package dependencies were used most recently to pass the embedded tests within this package. There is no guarantee of reproducible results using future versions of R or updated versions of package dependencies.
78+
79+
```
80+
devtools::session_info()
81+
Session info -----------------------------------------------------------------------------
82+
setting value
83+
version R version 3.4.1 (2017-06-30)
84+
system x86_64, mingw32
85+
ui RStudio (1.0.143)
86+
language (EN)
87+
collate English_United States.1252
88+
tz America/Chicago
89+
date 2017-07-27
90+
91+
Packages ---------------------------------------------------------------------------------
92+
package * version date source
93+
akima 0.6-2 2016-12-20 CRAN (R 3.4.0)
94+
assertthat 0.2.0 2017-04-11 CRAN (R 3.4.0)
95+
base * 3.4.1 2017-06-30 local
96+
bindr 0.1 2016-11-13 CRAN (R 3.4.0)
97+
bindrcpp 0.2 2017-06-17 CRAN (R 3.4.0)
98+
boot 1.3-19 2017-02-11 CRAN (R 3.4.1)
99+
car 2.1-5 2017-07-04 CRAN (R 3.4.1)
100+
codetools 0.2-15 2016-10-05 CRAN (R 3.4.1)
101+
coin 1.2-1 2017-07-17 CRAN (R 3.4.1)
102+
compiler 3.4.1 2017-06-30 local
103+
curl 2.8.1 2017-07-21 CRAN (R 3.4.1)
104+
dataRetrieval * 2.7.2 2017-05-23 CRAN (R 3.4.1)
105+
datasets * 3.4.1 2017-06-30 local
106+
devtools 1.13.2 2017-06-02 CRAN (R 3.4.1)
107+
digest 0.6.12 2017-01-27 CRAN (R 3.4.0)
108+
dplyr 0.7.2 2017-07-20 CRAN (R 3.4.1)
109+
glue 1.1.1 2017-06-21 CRAN (R 3.4.0)
110+
graphics * 3.4.1 2017-06-30 local
111+
grDevices * 3.4.1 2017-06-30 local
112+
grid 3.4.1 2017-06-30 local
113+
hms 0.3 2016-11-22 CRAN (R 3.4.0)
114+
httr 1.2.1 2016-07-03 CRAN (R 3.3.1)
115+
jsonlite 1.5 2017-06-01 CRAN (R 3.4.0)
116+
KernSmooth 2.23-15 2015-06-29 CRAN (R 3.4.1)
117+
lattice 0.20-35 2017-03-25 CRAN (R 3.4.1)
118+
leaps 3.0 2017-01-10 CRAN (R 3.4.0)
119+
lme4 1.1-13 2017-04-19 CRAN (R 3.4.0)
120+
lubridate * 1.6.0 2016-09-13 CRAN (R 3.4.0)
121+
magrittr 1.5 2014-11-22 CRAN (R 3.4.0)
122+
MASS 7.3-47 2017-02-26 CRAN (R 3.4.1)
123+
Matrix 1.2-10 2017-05-03 CRAN (R 3.4.1)
124+
MatrixModels 0.4-1 2015-08-22 CRAN (R 3.4.0)
125+
memoise 1.1.0 2017-04-21 CRAN (R 3.4.0)
126+
methods * 3.4.1 2017-06-30 local
127+
mgcv 1.8-17 2017-02-08 CRAN (R 3.4.0)
128+
minqa 1.2.4 2014-10-09 CRAN (R 3.4.0)
129+
modeltools 0.2-21 2013-09-02 CRAN (R 3.4.0)
130+
multcomp 1.4-6 2016-07-14 CRAN (R 3.4.0)
131+
mvtnorm 1.0-6 2017-03-02 CRAN (R 3.4.0)
132+
NADA 1.6-1 2017-03-31 CRAN (R 3.4.0)
133+
nlme 3.1-131 2017-02-06 CRAN (R 3.4.1)
134+
nloptr 1.0.4 2014-08-04 CRAN (R 3.4.0)
135+
nnet 7.3-12 2016-02-02 CRAN (R 3.4.1)
136+
parallel 3.4.1 2017-06-30 local
137+
pbkrtest 0.4-7 2017-03-15 CRAN (R 3.4.0)
138+
pkgconfig 2.0.1 2017-03-21 CRAN (R 3.4.0)
139+
plyr 1.8.4 2016-06-08 CRAN (R 3.3.1)
140+
quantreg 5.33 2017-04-18 CRAN (R 3.4.0)
141+
R6 2.2.2 2017-06-17 CRAN (R 3.4.0)
142+
randtests 1.0 2014-11-17 CRAN (R 3.4.0)
143+
Rcpp 0.12.12 2017-07-15 CRAN (R 3.4.1)
144+
readr 1.1.1 2017-05-16 CRAN (R 3.4.0)
145+
reshape2 1.4.2 2016-10-22 CRAN (R 3.4.0)
146+
rlang 0.1.1 2017-05-18 CRAN (R 3.4.1)
147+
rloadest * 0.4.5 2017-07-26 local
148+
rstudioapi 0.6 2016-06-27 CRAN (R 3.3.1)
149+
sandwich 2.3-4 2015-09-24 CRAN (R 3.4.0)
150+
segmented 0.5-2.1 2017-06-14 CRAN (R 3.4.0)
151+
smwrBase * 1.1.3 2017-05-02 Github (USGS-R/smwrBase@f7bef98)
152+
smwrGraphs * 1.1.3 2017-07-27 local
153+
smwrQW * 0.7.13 2017-07-26 local
154+
smwrStats * 0.7.6 2017-07-26 local
155+
sp 1.2-5 2017-06-29 CRAN (R 3.4.1)
156+
SparseM 1.77 2017-04-23 CRAN (R 3.4.0)
157+
splines 3.4.1 2017-06-30 local
158+
stats * 3.4.1 2017-06-30 local
159+
stats4 3.4.1 2017-06-30 local
160+
stringi 1.1.5 2017-04-07 CRAN (R 3.4.0)
161+
stringr 1.2.0 2017-02-18 CRAN (R 3.4.0)
162+
survival 2.41-3 2017-04-04 CRAN (R 3.4.0)
163+
TH.data 1.0-8 2017-01-23 CRAN (R 3.4.0)
164+
tibble 1.3.3 2017-05-28 CRAN (R 3.4.0)
165+
tools 3.4.1 2017-06-30 local
166+
truncnorm 1.0-7 2014-01-21 CRAN (R 3.3.0)
167+
utils * 3.4.1 2017-06-30 local
168+
withr 1.0.2 2016-06-20 CRAN (R 3.3.1)
169+
XML 3.98-1.9 2017-06-19 CRAN (R 3.4.0)
170+
xml2 1.1.1 2017-01-24 CRAN (R 3.4.0)
171+
zCompositions 1.0.3-1 2016-04-14 CRAN (R 3.4.0)
172+
zoo 1.8-0 2017-04-12 CRAN (R 3.4.0)
173+
```
174+
175+
## Disclaimer
42176

43-
Disclaimer
44-
----------
45177
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 at [https://www.usgs.gov/visual-id/credit_usgs.html#copyright](https://www.usgs.gov/visual-id/credit_usgs.html#copyright)
46178

47179
Although this software program has been used by the U.S. Geological Survey (USGS), no warranty, expressed or implied, is made by the USGS or the U.S. Government as to the accuracy and functioning of the program and related program material nor shall the fact of distribution constitute any such warranty, and no responsibility is assumed by the USGS in connection therewith.
20.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)