diff --git a/DESCRIPTION b/DESCRIPTION index b0fb5bf..b7bf7d6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: rLakeAnalyzer Title: Package for the analysis of lake physics Maintainer: Luke Winslow -Version: 1.7.0 +Version: 1.7.1 Author: Luke Winslow, Jordan Read, Richard Woolway, Jennifer Brentrup, Taylor Leach, Jake Zwart Description: Standardized methods for calculating common important derived @@ -12,5 +12,5 @@ Imports: plyr License: GPL (>= 2) Packaged: 2014-07-06 09:09:24 UTC; Luke -Repository: http://lakeanalyzer.gleon.org/ -Date/Publication: 2014-07-06 09:09:24 +Repository: https://github.com/GLEON/rLakeAnalyzer +Date/Publication: 2015-04-02 12:00:00 diff --git a/R/helper.functions.R b/R/helper.functions.R index 84114db..d0710ef 100644 --- a/R/helper.functions.R +++ b/R/helper.functions.R @@ -40,14 +40,14 @@ get.drho_dz <- function(wtr, depths){ } -#'@title Find and drop the datetime column from the datatable -#' -#'@description Liberally looks for a datetime column and drops it, -#'returning a data.frame with only water temperature. Errors if datetime column is -#'ambiguous. Warns if -#' -#'@return A data.frame with only the data, after datetime has been dropped -#' +#@title Find and drop the datetime column from the datatable +# +#description Liberally looks for a datetime column and drops it, +#returning a data.frame with only water temperature. Errors if datetime column is +#ambiguous. Warns if there is no match. +# +#@return A data.frame with only the data, after datetime has been dropped +# drop.datetime = function(data, error=FALSE){ header = names(data) @@ -68,10 +68,10 @@ drop.datetime = function(data, error=FALSE){ return(data[,-dt_indx]) } -#'@title Search for and return the datetime column from a ts data.frame -#' -#' -#' +#@title Search for and return the datetime column from a ts data.frame +# +#Warns if unavailable then returns NULL. +# get.datetime = function(data, error=FALSE){ header = names(data) diff --git a/R/thermo.depth.R b/R/thermo.depth.R index d15b9c8..379fcb4 100644 --- a/R/thermo.depth.R +++ b/R/thermo.depth.R @@ -1,4 +1,4 @@ -#' + #'@title Calculate depth of the thermocline from a temperature profile. #' #'@param wtr @@ -18,15 +18,15 @@ #'@param mixed.cutoff #'A cutoff (deg C) where below this threshold, thermo.depth and meta.depths #'are not calculated (NaN is returned). Defaults to 1 deg C. -#' #'@return -#'Depth of thermocline. If no thermocline found, value is max(depths). +#'Depth of thermocline. If no thermocline found, value is NaN. #' #'@description #'This function calculates the location of the thermocline from a temperature profile. #'It uses a special technique to estimate where the thermocline lies even between two #'temperature measurement depths, giving a potentially finer-scale estimate than usual techniques. #' +#' #'@author #'Luke Winslow #' diff --git a/R/wtr.plot.temp.R b/R/wtr.plot.temp.R index 39115c4..424780a 100644 --- a/R/wtr.plot.temp.R +++ b/R/wtr.plot.temp.R @@ -1,4 +1,4 @@ -#' + #'@title #'Creates a time series plot of the thermocline and top and #'bottom of the metalimnion diff --git a/man/drop.datetime.Rd b/man/drop.datetime.Rd deleted file mode 100644 index 8e82fa3..0000000 --- a/man/drop.datetime.Rd +++ /dev/null @@ -1,17 +0,0 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand -% Please edit documentation in R/helper.functions.R -\name{drop.datetime} -\alias{drop.datetime} -\title{Find and drop the datetime column from the datatable} -\usage{ -drop.datetime(data, error = FALSE) -} -\value{ -A data.frame with only the data, after datetime has been dropped -} -\description{ -Liberally looks for a datetime column and drops it, -returning a data.frame with only water temperature. Errors if datetime column is -ambiguous. Warns if -} - diff --git a/man/get.datetime.Rd b/man/get.datetime.Rd deleted file mode 100644 index 5527790..0000000 --- a/man/get.datetime.Rd +++ /dev/null @@ -1,12 +0,0 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand -% Please edit documentation in R/helper.functions.R -\name{get.datetime} -\alias{get.datetime} -\title{Search for and return the datetime column from a ts data.frame} -\usage{ -get.datetime(data, error = FALSE) -} -\description{ -Search for and return the datetime column from a ts data.frame -} - diff --git a/man/thermo.depth.Rd b/man/thermo.depth.Rd index 00776c1..136c551 100644 --- a/man/thermo.depth.Rd +++ b/man/thermo.depth.Rd @@ -26,15 +26,12 @@ as the starting point.} are not calculated (NaN is returned). Defaults to 1 deg C.} } \value{ -Depth of thermocline. If no thermocline found, value is max(depths). +Depth of thermocline. If no thermocline found, value is NaN. } \description{ This function calculates the location of the thermocline from a temperature profile. It uses a special technique to estimate where the thermocline lies even between two temperature measurement depths, giving a potentially finer-scale estimate than usual techniques. -} -\details{ - } \examples{ # A vector of water temperatures diff --git a/man/wtr.plot.temp.Rd b/man/wtr.plot.temp.Rd index f6de693..d84dcdc 100644 --- a/man/wtr.plot.temp.Rd +++ b/man/wtr.plot.temp.Rd @@ -15,9 +15,6 @@ wtr.plot.temp(wtr, ...) \description{ A line based plot of calculated depths of the thermocline, and top and bottom of the metalimnion from a temperature profile time series. -} -\details{ - } \examples{ wtr.path <- system.file('extdata', 'Sparkling.wtr', package="rLakeAnalyzer")