improve summary docs, generally and for ctd

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: oce
 Version: 0.9-19
-Date: 2016-06-17
+Date: 2016-06-18
 Title: Analysis of Oceanographic Data
 Authors@R: c(person(given="Dan", family="Kelley", email="[email protected]", role=c("aut", "cre")),
  person(given="Clark", family="Richards", email="[email protected]", role=c("aut")),

R/AllClass.R

@@ -32,13 +32,19 @@ setClass("oce",
 
 #' Summarize an oce Object
 #'
-#' Provide a summary of some pertinent aspects of the object, including
-#' important elements of its \code{metadata} slot and \code{data} slot,
+#' Provide a textual summary of some pertinent aspects of the object, including
+#' selected components of its \code{metadata} slot, statistical and
+#' dimensional information on the entries in the \code{data} slot,
 #' and a listing of the contents of its \code{processingLog} slot.
-#'
-#' The output is tailored to the object. This is not the way to learn
-#' everything about the object; programmers, for example, will often
-#' use \code{\link{str}} to get more details of the object structure.
+#' The details depend on the class of the object, especially for
+#' the \code{metadata} slot, so it can help to consult the specialized
+#' documentation, e.g. \code{\link{summary,ctd-method}} for CTD objects
+#' (i.e. objects inheriting from \code{\link{ctd-class}}.)
+#' It is important to note that this is not
+#' a good way to learn the details of the object contents. Instead,
+#' for an object named \code{object}, say, one might use \code{\link{str}(object)}
+#' to learn about all the contents, or \code{\link{str}(object[["metadata"]])}
+#' to learn about the \code{metadata}, etc.
 #'
 #' @param object The object to be summarized.
 #' @param ... Extra arguments (ignored)

R/ctd.R

@@ -284,7 +284,10 @@ setMethod(f="initialize",
 #' Summarize a CTD Object
 #' 
 #' Summarizes some of the data in a \code{ctd} object, presenting such information
-#' as the station name, sampling location, data ranges, etc.
+#' as the station name, sampling location, data ranges, etc. If the object was read
+#' from a \code{.cnv} file or a \code{.rsk} file, then the \code{OriginalName}
+#' column for the data summary will contain the original names of data within
+#' the source file.
 #'
 #' @param object A \code{ctd} object, i.e. one inheriting from \code{\link{ctd-class}}.
 #'