Merge pull request #55 from lawinslow/master

Fixed up warnings and notes for CRAN submission
GLEON · Apr 2, 2015 · 362cd43 · 362cd43
2 parents 93ab707 + 54a6197
commit 362cd43
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 55 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: rLakeAnalyzer
 Title: Package for the analysis of lake physics
 Maintainer: Luke Winslow <[email protected]>
-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
@@ -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
@@ -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
@@ -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
diff --git a/man/get.datetime.Rd b/man/get.datetime.Rd
diff --git 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
@@ -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")