From 7e76ec750a47e69b9ecc3bc8352b1eb81835a70a Mon Sep 17 00:00:00 2001 From: Jordan S Read Date: Mon, 9 Mar 2015 12:45:06 -0500 Subject: [PATCH] v0.6.2 GRAN checks addressed --- DESCRIPTION | 2 +- R/generic_metrics.R | 6 ++++++ R/read_field_stage.R | 6 ++---- man/plot_meteo.Rd | 2 +- man/read_field_stage.Rd | 2 ++ man/water.temperature.Rd | 22 ++++++++++++++++++++++ 6 files changed, 34 insertions(+), 6 deletions(-) create mode 100644 man/water.temperature.Rd diff --git a/DESCRIPTION b/DESCRIPTION index fd1767d..ef0bcd1 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -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 diff --git a/R/generic_metrics.R b/R/generic_metrics.R index ab20966..79636ef 100644 --- a/R/generic_metrics.R +++ b/R/generic_metrics.R @@ -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 diff --git a/R/read_field_stage.R b/R/read_field_stage.R index c5445e5..c62f1b3 100644 --- a/R/read_field_stage.R +++ b/R/read_field_stage.R @@ -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', diff --git a/man/plot_meteo.Rd b/man/plot_meteo.Rd index 568202f..82d0c34 100644 --- a/man/plot_meteo.Rd +++ b/man/plot_meteo.Rd @@ -24,7 +24,7 @@ plot_meteo(nml_file) Jordan S. Read, Luke A. Winslow } \seealso{ -\link{read_nml} +\code{\link{read_nml}} } \keyword{methods} diff --git a/man/read_field_stage.Rd b/man/read_field_stage.Rd index 7be5c76..df1da7e 100644 --- a/man/read_field_stage.Rd +++ b/man/read_field_stage.Rd @@ -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', diff --git a/man/water.temperature.Rd b/man/water.temperature.Rd new file mode 100644 index 0000000..ab17d95 --- /dev/null +++ b/man/water.temperature.Rd @@ -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}} +} +