document more datasets

brianstock · Apr 10, 2016 · 8834dc5 · 8834dc5
1 parent e3e9346
commit 8834dc5
Show file tree

Hide file tree

Showing 63 changed files with 213 additions and 134 deletions.
diff --git a/R/landsat.R b/R/landsat.R
@@ -168,6 +168,8 @@ setClass("landsat", contains="satellite")
 #'
 #' @name landsat
 #' @docType data
+#'
+#' @family datasets provided with \code{oce}
 #' @family things related to \code{landsat} data
 NULL
 

diff --git a/R/rsk.R b/R/rsk.R
@@ -41,6 +41,8 @@ setClass("rsk", contains="oce")
 #' plot(rsk)
 #' plot(as.ctd(rsk))
 #' plot(subset(as.ctd(rsk),pressure<10))
+#'
+#' @family datasets provided with \code{oce}
 #' @family things related to \code{rsk} data
 NULL
 

diff --git a/R/sealevel.R b/R/sealevel.R
@@ -36,8 +36,9 @@ setClass("sealevel", contains="oce")
 #' where the csv file was downloaded from [1]. Note the correction of longitude
 #' sign, which is required because the data file has no indication that this is
 #' the western hemisphere.
+#'
 #' @family datasets provided with \code{oce}
-#' @family classes provided by \code{oce}
+#' @family things related to \code{sealevel} data
 NULL
 
 #' Sea-level data set acquired in 1975 at Tuktoyaktuk
@@ -82,10 +83,10 @@ NULL
 #' lines(time, detided, col="red")
 #' }
 #' 
-#' @family things related to \code{ctd} data
+#' @family datasets provided with \code{oce}
+#' @family things related to \code{sealevel} data
 NULL
 
-
 setMethod(f="initialize",
           signature="sealevel",
           definition=function(.Object, elevation, time) {

diff --git a/R/windrose.R b/R/windrose.R
@@ -318,3 +318,22 @@ setMethod(f="plot",
           })
 
 
+### wind dataset (does not belong here, really, but I don't want to make another file)
+
+#' Wind dataset
+#' 
+#' Wind data inferred from Figure 5 of Koch et al. (1983), provided to
+#' illustrate the \code{\link{interpBarnes}} function.
+#' 
+#' Columns \code{wind$x} and \code{wind$y} are location, while
+#' \code{wind$z} is the wind speed, in m/s.
+#'
+#' @name wind
+#' @docType data
+#'
+#' @references S. E.  Koch and M.  DesJardins and P. J. Kocin, 1983.  ``An
+#' interactive Barnes objective map anlaysis scheme for use with satellite and
+#' conventional data,'' \emph{J.  Climate Appl.  Met.}, vol 22, p. 1487-1503.
+#'
+#' @family datasets provided with \code{oce}
+NULL
diff --git a/inst/doc/oce.Rmd b/inst/doc/oce.Rmd
@@ -517,8 +517,7 @@ stn <- section[["station", 100]]
 head(stn[["salinityFlag"]])
 ```
 Note that these data use the WHP scheme, i.e. good data are indicated with 2,
-whereas questionable data are indicated with 3. (How these assessments were
-made is of a matter for separate discussion.)
+whereas questionable data are indicated with 3.
 
 Before discussing how such flags might be handled, it is important to note that
 it is often necessary to alter such flags. For example, some datasets will have

diff --git a/inst/doc/oce.html b/inst/doc/oce.html
@@ -524,7 +524,7 @@ <h2><span class="header-section-number">9.2</span> Retrieving and changing flags
 stn &lt;-<span class="st"> </span>section[[<span class="st">&quot;station&quot;</span>, <span class="dv">100</span>]]
 <span class="kw">head</span>(stn[[<span class="st">&quot;salinityFlag&quot;</span>]])
 <span class="co">#&gt; [1] 2 2 2 2 2 3</span></code></pre></div>
-<p>Note that these data use the WHP scheme, i.e. good data are indicated with 2, whereas questionable data are indicated with 3. (How these assessments were made is of a matter for separate discussion.)</p>
+<p>Note that these data use the WHP scheme, i.e. good data are indicated with 2, whereas questionable data are indicated with 3.</p>
 <p>Before discussing how such flags might be handled, it is important to note that it is often necessary to alter such flags. For example, some datasets will have flags set to indicate good data, even though the data are set to -999, which is one of several old-fashioned missing-value codes. The <code>section</code> dataset does not contain any such cases, but the situation may be simulated as follows.</p>
 <div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r"><span class="co"># fake second datum</span>
 stn[[<span class="st">&quot;salinity&quot;</span>]][<span class="dv">2</span>] &lt;-<span class="st"> </span>-<span class="dv">999</span></code></pre></div>

diff --git a/man/adp-class.Rd b/man/adp-class.Rd
diff --git a/man/adp.Rd b/man/adp.Rd
diff --git a/man/adv-class.Rd b/man/adv-class.Rd
diff --git a/man/adv.Rd b/man/adv.Rd
diff --git a/man/argo-class.Rd b/man/argo-class.Rd
diff --git a/man/argo.Rd b/man/argo.Rd
diff --git a/man/as.ctd.Rd b/man/as.ctd.Rd
diff --git a/man/as.sealevel.Rd b/man/as.sealevel.Rd
diff --git a/man/bremen-class.Rd b/man/bremen-class.Rd
diff --git a/man/cm-class.Rd b/man/cm-class.Rd
diff --git a/man/cm.Rd b/man/cm.Rd
diff --git a/man/coastline-class.Rd b/man/coastline-class.Rd
diff --git a/man/coastlineWorld.Rd b/man/coastlineWorld.Rd
diff --git a/man/ctd-class.Rd b/man/ctd-class.Rd
diff --git a/man/ctd.Rd b/man/ctd.Rd
diff --git a/man/ctdAddColumn.Rd b/man/ctdAddColumn.Rd
diff --git a/man/ctdDecimate.Rd b/man/ctdDecimate.Rd
diff --git a/man/ctdFindProfiles.Rd b/man/ctdFindProfiles.Rd
diff --git a/man/ctdRaw.Rd b/man/ctdRaw.Rd
diff --git a/man/ctdTrim.Rd b/man/ctdTrim.Rd
diff --git a/man/ctdUpdateHeader.Rd b/man/ctdUpdateHeader.Rd
diff --git a/man/echosounder-class.Rd b/man/echosounder-class.Rd
diff --git a/man/echosounder.Rd b/man/echosounder.Rd
diff --git a/man/gps-class.Rd b/man/gps-class.Rd
diff --git a/man/handleFlags-ctd-method.Rd b/man/handleFlags-ctd-method.Rd