From 9f257ee9f6f0883a3fa3afeab5172ce636650260 Mon Sep 17 00:00:00 2001 From: dankelley Date: Fri, 27 Dec 2024 10:01:50 -0400 Subject: [PATCH] very minor rewording in two docs --- R/AllClass.R | 10 +++++----- docs/articles/A_oce.html | 2 +- docs/articles/B_ctd.html | 2 +- docs/articles/C_adp.html | 6 +++--- docs/articles/D_map_projections.html | 2 +- docs/articles/E_flags.html | 2 +- docs/articles/F_subclassing.html | 16 ++++++++-------- docs/articles/G_altering_defaults.html | 2 +- docs/articles/H_tides.html | 2 +- docs/pkgdown.yml | 2 +- docs/reference/D4902337_219.nc.html | 8 ++++---- docs/reference/adp_rdi.000.html | 2 +- docs/reference/as.cm.html | 10 +++++----- docs/reference/as.ctd.html | 6 +++--- docs/reference/as.sealevel.html | 8 ++++---- docs/reference/as.section.html | 12 ++++++------ docs/reference/as.windrose.html | 4 ++-- docs/reference/ctd-class.html | 4 ++-- docs/reference/ctd.cnv.gz.html | 2 +- docs/reference/d200321-001.ctd.gz.html | 2 +- docs/reference/d201211_0011.cnv.gz.html | 2 +- docs/reference/initialize-ctd-method.html | 2 +- docs/reference/magneticField.html | 6 +++--- docs/reference/oce-class.html | 14 +++++++------- docs/reference/presentTime.html | 8 ++++---- docs/reference/processingLog-set.html | 2 +- docs/reference/read.adp.rdi.html | 4 ++-- docs/reference/read.xbt.edf.html | 6 +++--- docs/reference/read.xbt.edf2.html | 4 ++-- docs/reference/read.xbt.html | 6 +++--- docs/reference/rename.html | 10 +++++----- docs/reference/summary-oce-method.html | 2 +- docs/reference/tidem.html | 8 ++++---- docs/reference/xbt.edf.html | 6 +++--- docs/reference/xbt2.edf.html | 4 ++-- docs/search.json | 2 +- man/oce-class.Rd | 4 ++-- man/presentTime.Rd | 4 ++-- 38 files changed, 99 insertions(+), 99 deletions(-) diff --git a/R/AllClass.R b/R/AllClass.R index 8922685648..25cf194a4b 100644 --- a/R/AllClass.R +++ b/R/AllClass.R @@ -3,8 +3,8 @@ #' Get the Present Time, in a Stated Timezone #' #' @param tz String indicating the desired timezone. The default is -#' to use UTC, which is used very commonly in oceanographic work. To -#' get the local time, use `tz=""` or `tz=NULL`, +#' to use UTC, which is used commonly in oceanographic work. To +#' get the local time, use `tz=""` or `tz=NULL`, as in \dQuote{Examples}. #' #' @examples #' presentTime() # UTC @@ -25,8 +25,8 @@ presentTime <- function(tz = "UTC") { #' Base Class for oce Objects #' #' This is mainly used within oce to create sub-classes, although -#' users can use `new("oce")` to create a blank `oce` -#' object, if desired. +#' users may wish to mek direct calls to `new("oce")` for +#' their own purposes. #' #' @slot metadata A list containing information about the data. The #' contents vary across sub-classes, e.g. an [adp-class] @@ -481,7 +481,7 @@ setMethod( f = "[[", signature(x = "oce", i = "ANY", j = "ANY"), definition = function(x, i, j, ...) { - #message("DAN AllClass [[ method: 1 i=", i) + # message("DAN AllClass [[ method: 1 i=", i) metadataNames <- sort(names(x@metadata)) dataNames <- sort(names(x@data)) # dots <- list(...) diff --git a/docs/articles/A_oce.html b/docs/articles/A_oce.html index e56fa6b454..1cf7e8ba06 100644 --- a/docs/articles/A_oce.html +++ b/docs/articles/A_oce.html @@ -67,7 +67,7 @@

1. Introduction to Oce

Dan Kelley (https://orcid.org/0000-0001-7808-5911) and Clark Richards (https://orcid.org/0000-0002-7833-206X)

-

2024-12-26

+

2024-12-27

Source: vignettes/A_oce.Rmd
A_oce.Rmd
diff --git a/docs/articles/B_ctd.html b/docs/articles/B_ctd.html index b030df86d9..706c850c90 100644 --- a/docs/articles/B_ctd.html +++ b/docs/articles/B_ctd.html @@ -67,7 +67,7 @@

2. Analysis of CTD data

Dan Kelley (https://orcid.org/0000-0001-7808-5911) and Clark Richards (https://orcid.org/0000-0002-7833-206X)

-

2024-12-26

+

2024-12-27

Source: vignettes/B_ctd.Rmd
B_ctd.Rmd
diff --git a/docs/articles/C_adp.html b/docs/articles/C_adp.html index f0d9b53cda..24b03f7ef1 100644 --- a/docs/articles/C_adp.html +++ b/docs/articles/C_adp.html @@ -66,7 +66,7 @@

3. Analysis of acoustic-Doppler data

Dan Kelley (https://orcid.org/0000-0001-7808-5911)

-

2024-12-26

+

2024-12-27

Source: vignettes/C_adp.Rmd
C_adp.Rmd
@@ -444,8 +444,8 @@

Solutions to exercises#> Signif. codes: 0 '***' 0.001 '**' 0.01 '*' 0.05 '.' 0.1 ' ' 1 #> * Processing Log #> -#> - 2024-12-26 12:31:11 UTC: `create 'tidem' object` -#> - 2024-12-26 12:31:11 UTC: `tidem(t = as.sealevel(pressure, time))` +#> - 2024-12-27 14:00:33 UTC: `create 'tidem' object` +#> - 2024-12-27 14:00:33 UTC: `tidem(t = as.sealevel(pressure, time))`

(Note that it fitted for M2, but not S2, because the Rayleigh criterion prevents inferring both, and the conventional tidal analysis favours M2 over S2 if the time series is too short to fit for more than diff --git a/docs/articles/D_map_projections.html b/docs/articles/D_map_projections.html index 3e4f88abfc..4f8c4eae6f 100644 --- a/docs/articles/D_map_projections.html +++ b/docs/articles/D_map_projections.html @@ -66,7 +66,7 @@

4. Using map projections

Dan Kelley (https://orcid.org/0000-0001-7808-5911)

-

2024-12-26

+

2024-12-27

Source: vignettes/D_map_projections.Rmd
D_map_projections.Rmd
diff --git a/docs/articles/E_flags.html b/docs/articles/E_flags.html index 0ad8df93c2..9c696d0334 100644 --- a/docs/articles/E_flags.html +++ b/docs/articles/E_flags.html @@ -66,7 +66,7 @@

5. Dealing with data-quality flags

Dan Kelley (https://orcid.org/0000-0001-7808-5911)

-

2024-12-26

+

2024-12-27

Source: vignettes/E_flags.Rmd
E_flags.Rmd
diff --git a/docs/articles/F_subclassing.html b/docs/articles/F_subclassing.html index 533c61e8c8..c6a4191548 100644 --- a/docs/articles/F_subclassing.html +++ b/docs/articles/F_subclassing.html @@ -66,7 +66,7 @@

6. Subclassing oce objects

Dan Kelley (https://orcid.org/0000-0001-7808-5911)

-

2024-12-26

+

2024-12-27

Source: vignettes/F_subclassing.Rmd
F_subclassing.Rmd
@@ -135,7 +135,7 @@

Using the base oce classsummary(o) #> * Processing Log #> -#> - 2024-12-26 12:31:20 UTC: `Create oce object` +#> - 2024-12-27 14:00:41 UTC: `Create oce object`

but if we populate the object with some data and metadata

+#> - 2024-12-27 14:00:41 UTC: `Create oce object` +#> - 2024-12-27 14:00:42 UTC: `oceSetData(object = o, name = "time", value = db$t)` +#> - 2024-12-27 14:00:42 UTC: `oceSetData(object = o, name = "longitude", value = db$lon)` +#> - 2024-12-27 14:00:42 UTC: `oceSetData(object = o, name = "latitude", value = db$lat)` +#> - 2024-12-27 14:00:42 UTC: `oceSetMetadata(object = o, name = "ID", value = 4201703)`

Note, however, that the ID is not listed by summary(). This is because the general form of that function is set up to focus on the contents of the data @@ -322,7 +322,7 @@

Specializing the summary() function#> #> * Processing Log #> -#> - 2024-12-26 12:31:20 UTC: `create 'drifter' object` +#> - 2024-12-27 14:00:42 UTC: `create 'drifter' object`

Specializing the [[ accessor diff --git a/docs/articles/G_altering_defaults.html b/docs/articles/G_altering_defaults.html index 9467fb05f6..62c1a2a60b 100644 --- a/docs/articles/G_altering_defaults.html +++ b/docs/articles/G_altering_defaults.html @@ -66,7 +66,7 @@

7. Altering oce Defaults

Dan Kelley (https://orcid.org/0000-0001-7808-5911)

-

2024-12-26

+

2024-12-27

Source: vignettes/G_altering_defaults.Rmd
G_altering_defaults.Rmd
diff --git a/docs/articles/H_tides.html b/docs/articles/H_tides.html index 2451b9e4db..f9800cca6a 100644 --- a/docs/articles/H_tides.html +++ b/docs/articles/H_tides.html @@ -67,7 +67,7 @@

8. Tidal Analysis

Dan Kelley (https://orcid.org/0000-0001-7808-5911) and Clark Richards (https://orcid.org/0000-0002-7833-206X)

-

2024-12-26

+

2024-12-27

Source: vignettes/H_tides.Rmd
H_tides.Rmd
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 240ddbb007..a1357bf865 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -10,7 +10,7 @@ articles: F_subclassing: F_subclassing.html G_altering_defaults: G_altering_defaults.html H_tides: H_tides.html -last_built: 2024-12-26T12:29Z +last_built: 2024-12-27T13:58Z urls: reference: https://dankelley.github.io/oce/reference article: https://dankelley.github.io/oce/articles diff --git a/docs/reference/D4902337_219.nc.html b/docs/reference/D4902337_219.nc.html index b0ab0cb25c..a04c3c7da5 100644 --- a/docs/reference/D4902337_219.nc.html +++ b/docs/reference/D4902337_219.nc.html @@ -100,7 +100,7 @@

Examples#> Argo Summary #> ------------ #> -#> * Source: "/private/var/folders/8b/l4h64m1j22v5pb7vj049ff140000gn/T/RtmprH1Kil/temp_libpathbbbb6d6914f0/oce/extdata/D4902337_219.nc" +#> * Source: "/private/var/folders/8b/l4h64m1j22v5pb7vj049ff140000gn/T/Rtmp8TUXQ7/temp_libpath5eb73ae2776b/oce/extdata/D4902337_219.nc" #> * ID: "4902337" #> * Feature type: "trajectoryProfile" #> * Profiles: 2 delayed; 0 adjusted; 0 realtime @@ -137,9 +137,9 @@

Examples#> #> * Processing Log #> -#> - 2024-12-26 12:29:13 UTC: `create 'argo' object` -#> - 2024-12-26 12:29:13 UTC: `initializeFlagScheme(object, name="argo", mapping=list(not_assessed=0,passed_all_tests=1,probably_good=2,probably_bad=3,bad=4,changed=5,not_used_6=6,not_used_7=7,estimated=8,missing=9)), default=c(0,3,4,9))` -#> - 2024-12-26 12:29:13 UTC: `read.argo(file="/private/var/folders/8b/l4h64m1j22v5pb7vj049ff140000gn/T/RtmprH1Kil/temp_libpathbbbb6d6914f0/oce/extdata/D4902337_219.nc")` +#> - 2024-12-27 13:58:34 UTC: `create 'argo' object` +#> - 2024-12-27 13:58:34 UTC: `initializeFlagScheme(object, name="argo", mapping=list(not_assessed=0,passed_all_tests=1,probably_good=2,probably_bad=3,bad=4,changed=5,not_used_6=6,not_used_7=7,estimated=8,missing=9)), default=c(0,3,4,9))` +#> - 2024-12-27 13:58:34 UTC: `read.argo(file="/private/var/folders/8b/l4h64m1j22v5pb7vj049ff140000gn/T/Rtmp8TUXQ7/temp_libpath5eb73ae2776b/oce/extdata/D4902337_219.nc")`

diff --git a/docs/reference/adp_rdi.000.html b/docs/reference/adp_rdi.000.html index 4ea65b89da..89de66ea5c 100644 --- a/docs/reference/adp_rdi.000.html +++ b/docs/reference/adp_rdi.000.html @@ -112,7 +112,7 @@

See also

Examples

read.oce(system.file("extdata", "adp_rdi.000", package = "oce"))
-#> adp object, from file "/private/var/folders/8b/l4h64m1j22v5pb7vj049ff140000gn/T/RtmprH1Kil/temp_libpathbbbb6d6914f0/oce/extdata/adp_rdi.000", with data slot containing:
+#> adp object, from file "/private/var/folders/8b/l4h64m1j22v5pb7vj049ff140000gn/T/Rtmp8TUXQ7/temp_libpath5eb73ae2776b/oce/extdata/adp_rdi.000", with data slot containing:
 #>    distance[1:84]: 2.23, 2.73, ..., 43.23, 43.73
 #>    time[1:9]: 2008-06-25 10:00:00, 2008-06-25 10:00:10, ..., 2008-06-25 10:01:10, 2008-06-25 10:01:20
 #>    pressure[1:9]: -0.244, -0.224, ..., -0.238, -0.266
diff --git a/docs/reference/as.cm.html b/docs/reference/as.cm.html
index bd7c2ac1c0..5e571ec3de 100644
--- a/docs/reference/as.cm.html
+++ b/docs/reference/as.cm.html
@@ -132,19 +132,19 @@ 
Examples#> ----------
 #> 
 #> * North:         magnetic
-#> * Time: 2024-12-26 08:29:19 to 2024-12-26 08:30:09 (51 samples, mean increment 1 s)
+#> * Time: 2024-12-27 09:58:40 to 2024-12-27 09:59:30 (51 samples, mean increment 1 s)
 #> * Data Overview
 #> 
 #>                     Min.                Mean                Max.                Dim. NAs
-#>     time            2024-12-26 12:29:19 2024-12-26 12:29:44 2024-12-26 12:30:09 51   0  
+#>     time            2024-12-27 13:58:40 2024-12-27 13:59:05 2024-12-27 13:59:30 51   0  
 #>     u [m/s]         -2.8628             0.0070087           3.2703              51   0  
 #>     v [m/s]         -2.5653             0.23561             2.4359              51   0  
 #>     pressure [dbar] 98.1                100.02              101.88              51   0  
 #> 
 #> * Processing Log
 #> 
-#>     - 2024-12-26 12:29:19 UTC: `create 'cm' object`
-#>     - 2024-12-26 12:29:19 UTC: `as.cm(time = t, u = u, v = v, pressure = p)`
+#>     - 2024-12-27 13:58:40 UTC: `create 'cm' object`
+#>     - 2024-12-27 13:58:40 UTC: `as.cm(time = t, u = u, v = v, pressure = p)`
 
 # Example 2: creation from an adv object
 data(adv)
@@ -173,7 +173,7 @@ 
Examples#>     - 2015-12-23 17:53:55 UTC: `use aquadoppHR heading; despike own pitch and roll`
 #>     - 2015-12-23 17:54:11 UTC: `beamToXyzAdv(x = x)`
 #>     - 2015-12-23 17:54:34 UTC: `xyzToEnu(x, declination=-18.099, horizontalCase=TRUE, sensorOrientiation=upward, debug=0)`
-#>     - 2024-12-26 12:29:19 UTC: `as.cm(time = adv)`
+#>     - 2024-12-27 13:58:40 UTC: `as.cm(time = adv)`
diff --git a/docs/reference/as.ctd.html b/docs/reference/as.ctd.html index efa9ab3c2d..8d5429906d 100644 --- a/docs/reference/as.ctd.html +++ b/docs/reference/as.ctd.html @@ -355,9 +355,9 @@

Examples#> #> * Processing Log #> -#> - 2024-12-26 12:29:19 UTC: `create 'ctd' object` -#> - 2024-12-26 12:29:19 UTC: `as.ctd(salinity = salinity, temperature = temperature, pressure = pressure)` -#> - 2024-12-26 12:29:19 UTC: `oceSetData(object = ctd, name = "fluorescence", value = fluo, unit = list(unit = expression(mg/m^3), scale = ""))` +#> - 2024-12-27 13:58:40 UTC: `create 'ctd' object` +#> - 2024-12-27 13:58:40 UTC: `as.ctd(salinity = salinity, temperature = temperature, pressure = pressure)` +#> - 2024-12-27 13:58:40 UTC: `oceSetData(object = ctd, name = "fluorescence", value = fluo, unit = list(unit = expression(mg/m^3), scale = ""))` # 2. fake data, with supplied units (which are the defaults, actually) ctd <- as.ctd(salinity, temperature, pressure, diff --git a/docs/reference/as.sealevel.html b/docs/reference/as.sealevel.html index 702a16c122..d839bd7589 100644 --- a/docs/reference/as.sealevel.html +++ b/docs/reference/as.sealevel.html @@ -211,8 +211,8 @@

Examples#> #> * Processing Log #> -#> - 2024-12-26 12:29:20 UTC: `create 'sealevel' object` -#> - 2024-12-26 12:29:20 UTC: `as.sealevel(elevation = elevation)` +#> - 2024-12-27 13:58:41 UTC: `create 'sealevel' object` +#> - 2024-12-27 13:58:41 UTC: `as.sealevel(elevation = elevation)` # As above, but start at the Y2K time. time <- as.POSIXct("2000-01-01") + h * 3600 @@ -234,8 +234,8 @@

Examples#> #> * Processing Log #> -#> - 2024-12-26 12:29:20 UTC: `create 'sealevel' object` -#> - 2024-12-26 12:29:20 UTC: `as.sealevel(elevation = elevation, time = time)` +#> - 2024-12-27 13:58:41 UTC: `create 'sealevel' object` +#> - 2024-12-27 13:58:41 UTC: `as.sealevel(elevation = elevation, time = time)`