Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GRAN checks #134

Merged
merged 2 commits into from
Mar 9, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: glmtools
Type: Package
Title: glmtools
Version: 0.6.1
Version: 0.6.2
Date: 2013-09-18
Author: Jordan S Read, Luke A Winslow
Maintainer: Jordan S Read <jread@usgs.gov>
Expand Down
6 changes: 6 additions & 0 deletions R/generic_metrics.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
#holder for glmtools metrics that follow rLA conventions
#'@title mimic rLakeAnalyzer function
#'@details used to mimic an rLakeAnalyzer function, so that it will
#'be recognized by a call to \code{\link{sim_metrics}}
#'@param wtr a water temperature data.frame
#'
#'@seealso \code{\link{sim_metrics}}, \code{\link{compare_to_field}}, \code{\link{validate_sim}}
#'@export
water.temperature <- function(wtr){
wtr
Expand Down
6 changes: 2 additions & 4 deletions R/read_field_stage.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@
#'@title Read in a field stage file
#'
#'@param file Path to stage TSV or CSV file
#'
#'@details
#'will read file from an assumed standard format.
#'@description
#'Reads a field file for stage. Field file must be either
#'a TSV (tab separated) or CSV (comma separated) file with
#'columns named "datetime" and "stage" (in meters). Datetime
#'format must be yyyy-mm-dd
#'
#'
#'@author Luke Winslow
#'
#'@examples
#'
#'field_file = system.file('extdata/field_stage.csv',
Expand Down
2 changes: 1 addition & 1 deletion man/plot_meteo.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ plot_meteo(nml_file)
Jordan S. Read, Luke A. Winslow
}
\seealso{
\link{read_nml}
\code{\link{read_nml}}
}
\keyword{methods}

2 changes: 2 additions & 0 deletions man/read_field_stage.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ format must be yyyy-mm-dd
}
\details{


will read file from an assumed standard format.
}
\examples{
field_file = system.file('extdata/field_stage.csv',
Expand Down
22 changes: 22 additions & 0 deletions man/water.temperature.Rd
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
% Generated by roxygen2 (4.1.0): do not edit by hand
% Please edit documentation in R/generic_metrics.R
\name{water.temperature}
\alias{water.temperature}
\title{mimic rLakeAnalyzer function}
\usage{
water.temperature(wtr)
}
\arguments{
\item{wtr}{a water temperature data.frame}
}
\description{
mimic rLakeAnalyzer function
}
\details{
used to mimic an rLakeAnalyzer function, so that it will
be recognized by a call to \code{\link{sim_metrics}}
}
\seealso{
\code{\link{sim_metrics}}, \code{\link{compare_to_field}}, \code{\link{validate_sim}}
}