diff --git a/.Rbuildignore b/.Rbuildignore index ac827a3e..6324a192 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -25,3 +25,4 @@ issues ^CRAN-RELEASE$ ^codemeta\.json$ ^CRAN-SUBMISSION$ +.markdownlint.yaml diff --git a/.github/workflows/rhub.yaml b/.github/workflows/rhub.yaml new file mode 100644 index 00000000..72c60a5c --- /dev/null +++ b/.github/workflows/rhub.yaml @@ -0,0 +1,94 @@ +# R-hub's generic GitHub Actions workflow file. It's canonical location is at +# https://github.com/r-hub/actions/blob/v1/workflows/rhub.yaml +# You can update this file to a newer version using the rhub2 package: +# +# rhub::rhub_setup() +# +# It is unlikely that you need to modify this file manually. + +name: R-hub +run-name: "${{ github.event.inputs.id }}: ${{ github.event.inputs.name || format('Manually run by {0}', github.triggering_actor) }}" + +on: + workflow_dispatch: + inputs: + config: + description: "A comma separated list of R-hub platforms to use." + type: string + default: "linux,windows,macos" + name: + description: "Run name. You can leave this empty now." + type: string + id: + description: "Unique ID. You can leave this empty now." + type: string + +jobs: + setup: + runs-on: ubuntu-latest + outputs: + containers: ${{ steps.rhub-setup.outputs.containers }} + platforms: ${{ steps.rhub-setup.outputs.platforms }} + + steps: + # NO NEED TO CHECKOUT HERE + - uses: r-hub/actions/setup@v1 + with: + config: ${{ github.event.inputs.config }} + id: rhub-setup + + linux-containers: + needs: setup + if: ${{ needs.setup.outputs.containers != '[]' }} + runs-on: ubuntu-latest + name: ${{ matrix.config.label }} + strategy: + fail-fast: false + matrix: + config: ${{ fromJson(needs.setup.outputs.containers) }} + container: + image: ${{ matrix.config.container }} + + steps: + - uses: r-hub/actions/checkout@v1 + - uses: r-hub/actions/platform-info@v1 + with: + token: ${{ secrets.RHUB_TOKEN }} + job-config: ${{ matrix.config.job-config }} + - uses: r-hub/actions/setup-deps@v1 + with: + token: ${{ secrets.RHUB_TOKEN }} + job-config: ${{ matrix.config.job-config }} + - uses: r-hub/actions/run-check@v1 + with: + token: ${{ secrets.RHUB_TOKEN }} + job-config: ${{ matrix.config.job-config }} + + other-platforms: + needs: setup + if: ${{ needs.setup.outputs.platforms != '[]' }} + runs-on: ${{ matrix.config.os }} + name: ${{ matrix.config.label }} + strategy: + fail-fast: false + matrix: + config: ${{ fromJson(needs.setup.outputs.platforms) }} + + steps: + - uses: r-hub/actions/checkout@v1 + - uses: r-hub/actions/setup-r@v1 + with: + job-config: ${{ matrix.config.job-config }} + token: ${{ secrets.RHUB_TOKEN }} + - uses: r-hub/actions/platform-info@v1 + with: + token: ${{ secrets.RHUB_TOKEN }} + job-config: ${{ matrix.config.job-config }} + - uses: r-hub/actions/setup-deps@v1 + with: + job-config: ${{ matrix.config.job-config }} + token: ${{ secrets.RHUB_TOKEN }} + - uses: r-hub/actions/run-check@v1 + with: + job-config: ${{ matrix.config.job-config }} + token: ${{ secrets.RHUB_TOKEN }} diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 00000000..f95cc595 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,3 @@ +# https://github.com/DavidAnson/markdownlint/blob/v0.32.1/schema/.markdownlint.yaml +MD013: false +MD025: false diff --git a/DESCRIPTION b/DESCRIPTION index 5eaeedbe..5a0708d6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,5 +1,5 @@ Package: gsw -Version: 1.1-1 +Version: 1.2-0 Title: Gibbs Sea Water Functions Authors@R: c( person(given="Dan", @@ -16,7 +16,7 @@ Authors@R: c( family="SCOR/IAPSO", role=c("aut","cph"), comment="Original 'Matlab' and derived code")) -Copyright: Original algorithms and 'Matlab'/C library (c) 2015-2022 WG127 SCOR/IAPSO (Scientific Committee on Oceanic Research / International Association for the Physical Sciences of the Oceans, Working Group 127); C wrapper code and R code (c) 2015-2021 Dan Kelley and Clark Richards +Copyright: Original algorithms and 'Matlab'/C library (c) 2015-2023 WG127 SCOR/IAPSO (Scientific Committee on Oceanic Research / International Association for the Physical Sciences of the Oceans, Working Group 127); C wrapper code and R code (c) 2015-2023 Dan Kelley and Clark Richards Maintainer: Dan Kelley Depends: R (>= 3.5.0), @@ -32,6 +32,6 @@ LazyLoad: yes LazyData: no Packaged: Dan Kelley Encoding: UTF-8 -RoxygenNote: 7.2.1 +RoxygenNote: 7.3.2 BuildVignettes: true VignetteBuilder: knitr diff --git a/NAMESPACE b/NAMESPACE index 1e0a5cd9..c058cd5e 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -62,6 +62,7 @@ export(argfix, gsw_grav, gsw_Helmholtz_energy_ice, gsw_ice_fraction_to_freeze_seawater, + gsw_infunnel, gsw_internal_energy, gsw_internal_energy_ice, gsw_IPV_vs_fNsquared_ratio, diff --git a/NEWS.md b/NEWS.md index 7dbf82ce..9fe473ec 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,9 @@ +# gsw 1.2-0 + +* add `gsw_infunnel()` +* switch from `Calloc` to `R_Calloc` etc, so package builds with "strict" + header checking (issue #63). + # gsw 1.1-1 * Remove a journal link that fails because of an invalid certificate. @@ -5,9 +11,9 @@ # gsw 1.1-0 -This update is based on C code from https://github.com/TEOS-10/GSW-C (release +This update is based on C code from (release v3.06-16-0, commit 657216dd4f5ea079b5f0e021a4163e2d26893371) and the .mat data -file from https://github.com/TEOS-10/GSW-Matlab (commit +file from (commit 38c9635d6fd93e74c2648e4ee23cec49c1f58530). It was necessary to make some changes to the within-documentation test suite, as listed below; MRD stands for Mean Relative Difference from the values in the previous CRAN release of `gsw`, @@ -21,35 +27,34 @@ version 1.0-6 released 2021-07-07. # gsw 1.0-7 -- Update to GSW-C as of 2021-07-14, github commit +* Update to GSW-C as of 2021-07-14, github commit `bad2c9e4e154597ce563aaaf3ce09b1c52a2ab46`. This does not change any existing functions in GSW-R. -- Add gsw_SP_salinometer(). -- Add gsw_o2sol(). -- Add gsw_o2sol_SP_pt(). +* Add gsw_SP_salinometer(). +* Add gsw_o2sol(). +* Add gsw_o2sol_SP_pt(). # gsw 1.0-6 -- Update to GSW-C as of 2021-07-06, github commit +* Update to GSW-C as of 2021-07-06, github commit `9c10670e89fce906da2cebce3399d73c054e769e`. -- Remove dependency on the 'testthat' package. -- gsw_z_from_p() and gsw_p_from_z() gain parameters geo_strf_dyn_height and +* Remove dependency on the 'testthat' package. +* gsw_z_from_p() and gsw_p_from_z() gain parameters geo_strf_dyn_height and sea_surface_geopotential. -- Relax gsw_geo_strf_dyn_height() test, since values are tied to a new Matlab +* Relax gsw_geo_strf_dyn_height() test, since values are tied to a new Matlab interpolation scheme that is not incorporated in GSW-C. # gsw 1.0-5 -- Update to GSW-C 3.05-4. -- Make internal sort routines be machine-independent. +* Update to GSW-C 3.05-4. +* Make internal sort routines be machine-independent. # gsw 1.0-4 -- Update to GSW-C 3.05-3. -- Handle NaN values better. -- Add dozens of new GSW functions. +* Update to GSW-C 3.05-3. +* Handle NaN values better. +* Add dozens of new GSW functions. # gsw 1.0-3 -- First version, using GSW version 3.03. - +* First version, using GSW version 3.03. diff --git a/R/gsw.R b/R/gsw.R index 86138230..336795ee 100644 --- a/R/gsw.R +++ b/R/gsw.R @@ -65,6 +65,8 @@ #' #' @docType package #' @name gsw +#' @keywords internal +"_PACKAGE" NULL #' Global SA lookup file @@ -3297,7 +3299,7 @@ gsw_pot_enthalpy_from_pt_ice_poly <- function(pt0_ice) #' #' 2. The R code does not reproduce the check values stated at #' \url{http://www.teos-10.org/pubs/gsw/html/gsw_pot_enthalpy_ice_freezing.html}. Those -#' values are incorporated in the test provided in \dQuote{Examples}, so that test +#' values are incorporated in the test provided in \sQuote{Examples}, so that test #' is not performed during build tests. See https://github.com/TEOS-10/GSW-R/issues/27. #' @family things related to enthalpy ## @family things related to ice @@ -6082,3 +6084,61 @@ gsw_z_from_p <- function(p, latitude, geo_strf_dyn_height, sea_surface_geopotent rval } +#' Determine whether a point is inside the 'funnel' of acceptable values +#' +#' This function determines whether a given hydrographic value lies what +#' the TEOS-10 literature calls a "funnel" of values that lead to acceptably +#' accurate computation of specific volume. For more details, consult the +#' TEOS-10 literature, perhaps starting with the materials referred to in the +#' webpage cited in the \sQuote{References} section. +#' +#' @return a logical value indicating whether the given +#' point is inside the funnel of acceptable values. +#' +#' @template SAtemplate +#' @template CTtemplate +#' @template ptemplate +#' +#' @examples +#' library(gsw) +#' gsw_infunnel(35, 10, 100) # TRUE +#' gsw_infunnel(45, 10, 100) # FALSE: too salty +#' gsw_infunnel(35, -4, 100) # FALSE: below freezing +#' +#' @references +#' \url{https://www.teos-10.org/pubs/gsw/html/gsw_infunnel.html} +#' +#' @family things related to density +gsw_infunnel <- function(SA, CT, p) +{ + l <- argfix(list(SA=SA, CT=CT, p=p)) + n <- length(l[[1]]) + rval <- !((l$p > 8000) | + (l$SA < 0.0) | + (l$SA > 42.0) | + (l$p < 500.0 & l$CT < gsw_CT_freezing(l$SA, l$p)) | + (l$p >= 500.0 & l$p < 6500.0 & l$SA < l$p*4e-3 - 2.5) | + (l$p > 500.0 & l$p < 6500.0 & l$CT > (31.66666666666667 - l$p*3.333333333333334e-3)) | + (l$p >= 500.0 & l$CT < gsw_CT_freezing(l$SA, 500.0)) | + (l$p >= 6500.0 & l$SA < 30) | + (l$p >= 6500.0 & l$CT > 10.0)) + # Catch both NA input values and NA or NaN computed values + rval[!is.finite(rval)] <- TRUE + if (is.matrix(SA)) + dim(rval) <- dim(SA) + rval + #in_funnel = ones(size(SA)); + # + #in_funnel(p > 8000 |... + # SA < 0 |... + # SA > 42 |... + # (p < 500 & CT < gsw_CT_freezing(SA,p)) |... + # (p >= 500 & p < 6500 & SA < p*5e-3 - 2.5) |... + # (p > 500 & p < 6500 & CT > (31.66666666666667 - p*3.333333333333334e-3)) | ... + # (p >= 500 & CT < gsw_CT_freezing(SA,500)) |... + # (p >= 6500 & SA < 30) |... + # (p >= 6500 & CT > 10.0)) = 0; + # + #in_funnel(isnan(SA) | isnan(CT) | isnan(p)) = NaN; +} + diff --git a/README.md b/README.md index a7a4c2ed..7cee0ca4 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,25 @@ state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/) [![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/gsw)](https://cran.r-project.org/package=gsw) [![R-CMD-check](https://github.com/TEOS-10/GSW-R/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/TEOS-10/GSW-R/actions/workflows/R-CMD-check.yaml) +<<<<<<< HEAD ![RStudio CRAN mirror downloads](http://cranlogs.r-pkg.org/badges/last-month/gsw) ![RStudio CRAN mirror downloads](http://cranlogs.r-pkg.org/badges/last-week/gsw) ![RStudio CRAN mirror downloads](http://cranlogs.r-pkg.org/badges/last-day/gsw) +======= +[![R-hub](https://github.com/dankelley/GSW-R/actions/workflows/rhub.yaml/badge.svg)](https://github.com/dankelley/GSW-R/actions/workflows/rhub.yaml) +![RStudio CRAN mirror downloads](https://cranlogs.r-pkg.org/badges/last-month/gsw) +![RStudio CRAN mirror downloads](https://cranlogs.r-pkg.org/badges/last-week/gsw) +![RStudio CRAN mirror downloads](https://cranlogs.r-pkg.org/badges/last-day/gsw) +>>>>>>> develop ![RStudio CRAN mirror downloads](https://cranlogs.r-pkg.org/badges/grand-total/gsw) gsw is an R package that provides a connection to software relating to TEOS, -the Thermodynamic Equation Of Seawater (see http://www.teos-10.org). This +the Thermodynamic Equation Of Seawater (see ). This connection involves R wrappers to C functions within the GSW-C library -(https://github.com/TEOS-10/GSW-C, release v3.06-16-0, commit +(, release v3.06-16-0, commit 657216dd4f5ea079b5f0e021a4163e2d26893371), along with a data file within the GSW-Matlab library -(https://github.com/TEOS-10/GSW-Matlab/blob/master/Toolbox/library/gsw_data_v3_0.mat, +(, commit 38c9635d6fd93e74c2648e4ee23cec49c1f58530). The foundational algorithms upon which both GSW-C and GSW-R rest were devised @@ -26,12 +33,11 @@ recommended as a replacement for a previous system (called UNESCO-80) at the twenty-fifth assembly in the Intergovernmental Oceanographic Commission in 2009. -The gsw functions reproduce test values in the GSW-Fortran documentation to -a tolerance of 1.5e-8, the default for numerical comparison in R working on -a 64-bit machine. This offers some assurance that the coding process -has not introduced errors. +The gsw functions reproduce test values in the GSW-Matlab documentation to a +tolerance of 1.5e-8, the default for numerical comparison in R working on a +64-bit machine. This offers some assurance that the coding process has not +introduced errors. The naming convention in gsw is patterned on the system described at -http://www.teos-10.org/pubs/gsw/html/gsw_contents.html, as a way to reduce the -effort users might face in switching to R. - +, as a way to reduce +the effort users might face in switching to R. diff --git a/check_package.R b/check_package.R index a22c178e..668b69ba 100644 --- a/check_package.R +++ b/check_package.R @@ -1,4 +1,4 @@ -#install.packages("codemetar") +# install.packages("codemetar") requireNamespace(c("codemetar", "devtools", "urlchecker", "rhub", "revdepcheck")) # codemeta changes a timestamp, so requiring a commit after every call. That is # senseless, so I only run the false part of the following conditional in the @@ -14,14 +14,13 @@ urlchecker::url_check() devtools::check_win_release() devtools::check_win_devel() devtools::check_win_oldrelease() -# rhub was broken in 2022 June/July but seen to work again on Aug 16 -rhub::check_for_cran(email="Dan.Kelley@Dal.Ca", show_status=FALSE) -rhub::check(platform="debian-clang-devel", show_status=FALSE) -#> rhub::platforms() -#debian-clang-devel: -# Debian Linux, R-devel, clang, ISO-8859-15 locale -#> rhub::check_rhub() + +# 2024-08-19 DEK: rhub has been replaced by rhub2, so the following no longer +# work. The new system is complicated, and has the disadvantage that it only +# works on code that has been pushed to github ... so I will just use a github +# action instead, I think. +# rhub::check_for_cran(email = "Dan.Kelley@Dal.Ca", show_status = FALSE) +# rhub::check(platform = "debian-clang-devel", show_status = FALSE) remotes::install_github("r-lib/revdepcheck") revdepcheck::revdep_reset() -revdepcheck::revdep_check(num_workers=4) - +revdepcheck::revdep_check(num_workers = 4) diff --git a/codemeta.json b/codemeta.json index 1b173e9c..13b53cb0 100644 --- a/codemeta.json +++ b/codemeta.json @@ -7,13 +7,13 @@ "codeRepository": "https://github.com/TEOS-10/GSW-R", "issueTracker": "https://github.com/TEOS-10/GSW-R/issues", "license": "https://spdx.org/licenses/GPL-2.0", - "version": "1.1.1", + "version": "1.2.0", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R", "url": "https://r-project.org" }, - "runtimePlatform": "R version 4.2.1 (2022-06-23)", + "runtimePlatform": "R version 4.4.1 (2024-06-14)", "provider": { "@id": "https://cran.r-project.org", "@type": "Organization", @@ -118,11 +118,11 @@ }, "SystemRequirements": null }, - "fileSize": "5224.627KB", + "fileSize": "5165.753KB", "relatedLink": ["http://teos-10.github.io/GSW-R/", "https://CRAN.R-project.org/package=gsw"], "releaseNotes": "https://github.com/TEOS-10/GSW-R/blob/master/NEWS.md", "readme": "https://github.com/TEOS-10/GSW-R/blob/main/README.md", - "contIntegration": "https://github.com/TEOS-10/GSW-R/actions/workflows/R-CMD-check.yaml", + "contIntegration": ["https://github.com/TEOS-10/GSW-R/actions/workflows/R-CMD-check.yaml", "https://github.com/dankelley/GSW-R/actions/workflows/rhub.yaml"], "developmentStatus": "https://www.repostatus.org/", "keywords": ["seawater", "gibbs", "teos-10", "oceanography"] } diff --git a/cran-comments.md b/cran-comments.md index 358a975d..ec010184 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,12 +1,18 @@ -# Submission of 1.1-1 +# Submission of 1.2-0 -This should fix the NOTE and WARNING that were reported on a Debian test -machine during the submission of 1.1-0 yesterday. +This update was required by 2024-09-20, in order to accommodate the change from +the Calloc() and Free() macros to R_Calloc() and R_Free(). # Tests ## Local Tests +R 4.4.1 on macOS Beta 15.0 Beta (24A5298h) revealed no ERRORs, no WARNINGs, +or NOTEs. One NOTE was about the author name and the other about the package +size (a known issue; see above). These tests included those in the CRAN test +suite, along with other tests of datasets that are not provided with the +package. + * No problems on macOS (12.5 beta, intel) with R-4.2.1 (2022-06-23). ## Remote tests diff --git a/inst/WORDLIST b/inst/WORDLIST index 66d43d2f..968ea45b 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -14,6 +14,7 @@ Krause MRD McDougall NaN +ORCID PSS RStudio Rrho @@ -27,6 +28,7 @@ Sstar TEOS Thermobaric Vaisala +WG aaaf al argfix @@ -70,6 +72,7 @@ gridded haline http https +hydrographic hydrography isentropic isothermal diff --git a/man-roxygen/CTtemplate.R b/man-roxygen/CTtemplate.R index 3568769d..99707462 100644 --- a/man-roxygen/CTtemplate.R +++ b/man-roxygen/CTtemplate.R @@ -1,2 +1,2 @@ -#' @param CT Conservative Temperature [ degC ] +#' @param CT Conservative Temperature [ degC ]. diff --git a/man-roxygen/SAtemplate.R b/man-roxygen/SAtemplate.R index 585178fc..a0c006c4 100644 --- a/man-roxygen/SAtemplate.R +++ b/man-roxygen/SAtemplate.R @@ -1,2 +1,2 @@ -#' @param SA Absolute Salinity [ g/kg ] - +#' @param SA Absolute Salinity [ g/kg ]. The valid range for most `gsw` +#' functions is 0 to 42 g/kg. diff --git a/man-roxygen/SPtemplate.R b/man-roxygen/SPtemplate.R index b8243c7e..2e1533d1 100644 --- a/man-roxygen/SPtemplate.R +++ b/man-roxygen/SPtemplate.R @@ -1,2 +1,3 @@ -#' @param SP Practical Salinity (PSS-78) [ unitless ] +#' @param SP Practical Salinity (PSS-78) [ unitless ]. The valid range for most +#' `gsw` functions is from 2 to 42. diff --git a/man-roxygen/teos10template.R b/man-roxygen/teos10template.R index 28088427..05279610 100644 --- a/man-roxygen/teos10template.R +++ b/man-roxygen/teos10template.R @@ -1,8 +1,8 @@ #' @section Implementation Note: #' #' This R function uses a wrapper to a C function contained within the GSW-C -#' system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -#' git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +#' system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +#' git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. #' #' The C function uses data from the \code{library/gsw_data_v3_0.mat} #' file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw.Rd b/man/gsw.Rd index 9696de53..057ffab3 100644 --- a/man/gsw.Rd +++ b/man/gsw.Rd @@ -2,6 +2,7 @@ % Please edit documentation in R/gsw.R \docType{package} \name{gsw} +\alias{gsw-package} \alias{gsw} \title{R implementation of Thermodynamic Equation Of Seawater - 2010 (TEOS-10)} \description{ @@ -59,3 +60,22 @@ This can be handy with gridded datasets. However, the careful analyst will probably prefer to avoid this and other conveniences, supplying properly-matched arguments from the outset. } +\seealso{ +Useful links: +\itemize{ + \item \url{http://teos-10.github.io/GSW-R/} + \item Report bugs at \url{https://github.com/TEOS-10/GSW-R/issues} +} + +} +\author{ +\strong{Maintainer}: Dan Kelley \email{dan.kelley@dal.ca} (\href{https://orcid.org/0000-0001-7808-5911}{ORCID}) [copyright holder] + +Authors: +\itemize{ + \item Clark Richards \email{clark.richards@gmail.com} (\href{https://orcid.org/0000-0002-7833-206X}{ORCID}) [copyright holder] + \item WG127 SCOR/IAPSO (Original 'Matlab' and derived code) [copyright holder] +} + +} +\keyword{internal} diff --git a/man/gsw_CT_first_derivatives.Rd b/man/gsw_CT_first_derivatives.Rd index d134ef63..9b852061 100644 --- a/man/gsw_CT_first_derivatives.Rd +++ b/man/gsw_CT_first_derivatives.Rd @@ -7,7 +7,8 @@ gsw_CT_first_derivatives(SA, pt) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{pt}{potential temperature (ITS-90) [ degC ]} } @@ -24,8 +25,8 @@ First Derivatives of Conservative Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_CT_first_derivatives_wrt_t_exact.Rd b/man/gsw_CT_first_derivatives_wrt_t_exact.Rd index d846a9e3..12c819b7 100644 --- a/man/gsw_CT_first_derivatives_wrt_t_exact.Rd +++ b/man/gsw_CT_first_derivatives_wrt_t_exact.Rd @@ -8,7 +8,8 @@ Constant in-situ Temperature} gsw_CT_first_derivatives_wrt_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -31,8 +32,8 @@ Constant in-situ Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_CT_freezing.Rd b/man/gsw_CT_freezing.Rd index 07320006..52277da9 100644 --- a/man/gsw_CT_freezing.Rd +++ b/man/gsw_CT_freezing.Rd @@ -7,7 +7,8 @@ gsw_CT_freezing(SA, p, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -23,8 +24,8 @@ Conservative Temperature of Freezing Seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_CT_freezing_first_derivatives.Rd b/man/gsw_CT_freezing_first_derivatives.Rd index c28ad27e..f46f266d 100644 --- a/man/gsw_CT_freezing_first_derivatives.Rd +++ b/man/gsw_CT_freezing_first_derivatives.Rd @@ -7,7 +7,8 @@ gsw_CT_freezing_first_derivatives(SA, p, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -27,8 +28,8 @@ First Derivatives of Conservative Temperature for Freezing Water This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_CT_freezing_first_derivatives_poly.Rd b/man/gsw_CT_freezing_first_derivatives_poly.Rd index 565bc6c2..b8e692cc 100644 --- a/man/gsw_CT_freezing_first_derivatives_poly.Rd +++ b/man/gsw_CT_freezing_first_derivatives_poly.Rd @@ -7,7 +7,8 @@ gsw_CT_freezing_first_derivatives_poly(SA, p, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -27,8 +28,8 @@ First Derivatives of Conservative Temperature for Freezing Water (Polynomial ver This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_CT_freezing_poly.Rd b/man/gsw_CT_freezing_poly.Rd index b4309165..7494f6fe 100644 --- a/man/gsw_CT_freezing_poly.Rd +++ b/man/gsw_CT_freezing_poly.Rd @@ -7,7 +7,8 @@ gsw_CT_freezing_poly(SA, p, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -23,8 +24,8 @@ Conservative Temperature Freezing Point (Polynomial version) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_CT_from_enthalpy.Rd b/man/gsw_CT_from_enthalpy.Rd index 7aaa7668..b3e88aea 100644 --- a/man/gsw_CT_from_enthalpy.Rd +++ b/man/gsw_CT_from_enthalpy.Rd @@ -7,7 +7,8 @@ gsw_CT_from_enthalpy(SA, h, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{h}{specific enthalpy [ J/kg ]} @@ -23,8 +24,8 @@ Conservative Temperature from Enthalpy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,22 +56,22 @@ stopifnot(all.equal(CT, c(28.809854569021972, 28.439026483379287, 22.78619653409 \seealso{ Other things related to enthalpy: \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_CT_from_entropy.Rd b/man/gsw_CT_from_entropy.Rd index 9acb8274..a4c962d8 100644 --- a/man/gsw_CT_from_entropy.Rd +++ b/man/gsw_CT_from_entropy.Rd @@ -7,7 +7,8 @@ gsw_CT_from_entropy(SA, entropy) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{entropy}{specific entropy [ J/(degC*kg) ]} } @@ -21,8 +22,8 @@ Conservative Temperature from Entropy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_CT_from_pt.Rd b/man/gsw_CT_from_pt.Rd index 588326fb..79eef652 100644 --- a/man/gsw_CT_from_pt.Rd +++ b/man/gsw_CT_from_pt.Rd @@ -7,7 +7,8 @@ gsw_CT_from_pt(SA, pt) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{pt}{potential temperature (ITS-90) [ degC ]} } @@ -21,8 +22,8 @@ Conservative Temperature from Potential Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_CT_from_rho.Rd b/man/gsw_CT_from_rho.Rd index b00831e2..b085d101 100644 --- a/man/gsw_CT_from_rho.Rd +++ b/man/gsw_CT_from_rho.Rd @@ -9,7 +9,8 @@ gsw_CT_from_rho(rho, SA, p) \arguments{ \item{rho}{seawater density [ kg/m^3 ]} -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -24,8 +25,8 @@ Conservative Temperature from Density, Absolute Salinity and Pressure This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -56,28 +57,29 @@ stopifnot(all.equal(r$CT, c(28.784377302226968, 28.432402127485858, 22.808745445 Other things related to density: \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_CT_from_t.Rd b/man/gsw_CT_from_t.Rd index 16c3f4ec..4a0756c5 100644 --- a/man/gsw_CT_from_t.Rd +++ b/man/gsw_CT_from_t.Rd @@ -7,7 +7,8 @@ gsw_CT_from_t(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Convert from temperature to conservative temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_CT_maxdensity.Rd b/man/gsw_CT_maxdensity.Rd index c0dd13f7..bfcea67a 100644 --- a/man/gsw_CT_maxdensity.Rd +++ b/man/gsw_CT_maxdensity.Rd @@ -7,7 +7,8 @@ gsw_CT_maxdensity(SA, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -21,8 +22,8 @@ Conservative Temperature at Maximum Density This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -52,28 +53,29 @@ stopifnot(all.equal(CT, c(-3.731407240089855, -3.861137427731664, -4.06039060224 Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_CT_second_derivatives.Rd b/man/gsw_CT_second_derivatives.Rd index 59f78061..b998dd05 100644 --- a/man/gsw_CT_second_derivatives.Rd +++ b/man/gsw_CT_second_derivatives.Rd @@ -7,7 +7,8 @@ gsw_CT_second_derivatives(SA, pt) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{pt}{potential temperature (ITS-90) [ degC ]} } @@ -26,8 +27,8 @@ Second Derivatives of Conservative Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_C_from_SP.Rd b/man/gsw_C_from_SP.Rd index 93a71185..c9356769 100644 --- a/man/gsw_C_from_SP.Rd +++ b/man/gsw_C_from_SP.Rd @@ -7,7 +7,8 @@ gsw_C_from_SP(SP, t, p) } \arguments{ -\item{SP}{Practical Salinity (PSS-78) [ unitless ]} +\item{SP}{Practical Salinity (PSS-78) [ unitless ]. The valid range for most +`gsw` functions is from 2 to 42.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -26,8 +27,8 @@ p=0). This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -56,8 +57,8 @@ stopifnot(all.equal(C, c(56.412599581571186, 56.316185602699953, 50.670369333973 } \seealso{ Other things related to salinity: -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SA}()}, diff --git a/man/gsw_Fdelta.Rd b/man/gsw_Fdelta.Rd index 5f1321af..0960d865 100644 --- a/man/gsw_Fdelta.Rd +++ b/man/gsw_Fdelta.Rd @@ -25,8 +25,8 @@ Ratio of Absolute to Preformed Salinity, minus 1 This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_Helmholtz_energy_ice.Rd b/man/gsw_Helmholtz_energy_ice.Rd index c883513a..982ceac0 100644 --- a/man/gsw_Helmholtz_energy_ice.Rd +++ b/man/gsw_Helmholtz_energy_ice.Rd @@ -21,8 +21,8 @@ Helmholtz Energy of Ice This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_IPV_vs_fNsquared_ratio.Rd b/man/gsw_IPV_vs_fNsquared_ratio.Rd index 56e178f5..af5f7975 100644 --- a/man/gsw_IPV_vs_fNsquared_ratio.Rd +++ b/man/gsw_IPV_vs_fNsquared_ratio.Rd @@ -7,9 +7,10 @@ gsw_IPV_vs_fNsquared_ratio(SA, CT, p, p_ref = 0) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -26,8 +27,8 @@ version of the library will address the bug directly. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_Nsquared.Rd b/man/gsw_Nsquared.Rd index d1e69de4..fc1b249c 100644 --- a/man/gsw_Nsquared.Rd +++ b/man/gsw_Nsquared.Rd @@ -7,9 +7,10 @@ gsw_Nsquared(SA, CT, p, latitude = 0) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -30,8 +31,8 @@ dataset provided in the \CRANpkg{oce} package). This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_O2sol.Rd b/man/gsw_O2sol.Rd index 36e0a8f3..0502ec75 100644 --- a/man/gsw_O2sol.Rd +++ b/man/gsw_O2sol.Rd @@ -7,9 +7,10 @@ gsw_O2sol(SA, CT, p, longitude, latitude) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -38,8 +39,8 @@ terms. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_O2sol_SP_pt.Rd b/man/gsw_O2sol_SP_pt.Rd index 3cdc5027..7cf82b74 100644 --- a/man/gsw_O2sol_SP_pt.Rd +++ b/man/gsw_O2sol_SP_pt.Rd @@ -7,7 +7,8 @@ gsw_O2sol_SP_pt(SP, pt) } \arguments{ -\item{SP}{Practical Salinity (PSS-78) [ unitless ]} +\item{SP}{Practical Salinity (PSS-78) [ unitless ]. The valid range for most +`gsw` functions is from 2 to 42.} \item{pt}{potential temperature (ITS-90) [ degC ]} } @@ -28,8 +29,8 @@ computation in GSW variables. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_SAAR.Rd b/man/gsw_SAAR.Rd index cd7b5c60..8d66ded5 100644 --- a/man/gsw_SAAR.Rd +++ b/man/gsw_SAAR.Rd @@ -27,8 +27,8 @@ Absolute Salinity Anomaly Ratio This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_SA_freezing_from_CT.Rd b/man/gsw_SA_freezing_from_CT.Rd index 42396d05..88d942e6 100644 --- a/man/gsw_SA_freezing_from_CT.Rd +++ b/man/gsw_SA_freezing_from_CT.Rd @@ -7,7 +7,7 @@ gsw_SA_freezing_from_CT(CT, p, saturation_fraction = 1) } \arguments{ -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -23,8 +23,8 @@ Compute Absolute Salinity at Freezing Conservative Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_SA_freezing_from_CT_poly.Rd b/man/gsw_SA_freezing_from_CT_poly.Rd index ce964e9f..f8b2c400 100644 --- a/man/gsw_SA_freezing_from_CT_poly.Rd +++ b/man/gsw_SA_freezing_from_CT_poly.Rd @@ -7,7 +7,7 @@ gsw_SA_freezing_from_CT_poly(CT, p, saturation_fraction = 1) } \arguments{ -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -23,8 +23,8 @@ Compute Absolute Salinity at Freezing Point (Polynomial version) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_SA_freezing_from_t.Rd b/man/gsw_SA_freezing_from_t.Rd index 4918b93c..c72edcde 100644 --- a/man/gsw_SA_freezing_from_t.Rd +++ b/man/gsw_SA_freezing_from_t.Rd @@ -23,8 +23,8 @@ Compute Absolute Salinity at Freezing in-situ Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_SA_freezing_from_t_poly.Rd b/man/gsw_SA_freezing_from_t_poly.Rd index f43d72f2..b5ecdcf8 100644 --- a/man/gsw_SA_freezing_from_t_poly.Rd +++ b/man/gsw_SA_freezing_from_t_poly.Rd @@ -23,8 +23,8 @@ Compute Absolute Salinity at Freezing in-situ Temperature (Polynomial version) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_SA_from_SP.Rd b/man/gsw_SA_from_SP.Rd index 99ef0288..ffb12a9f 100644 --- a/man/gsw_SA_from_SP.Rd +++ b/man/gsw_SA_from_SP.Rd @@ -7,7 +7,8 @@ gsw_SA_from_SP(SP, p, longitude, latitude) } \arguments{ -\item{SP}{Practical Salinity (PSS-78) [ unitless ]} +\item{SP}{Practical Salinity (PSS-78) [ unitless ]. The valid range for most +`gsw` functions is from 2 to 42.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -33,8 +34,8 @@ converted to analogous matrices with \code{\link{expand.grid}}. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_SA_from_SP_Baltic.Rd b/man/gsw_SA_from_SP_Baltic.Rd index 85151487..965ce7a4 100644 --- a/man/gsw_SA_from_SP_Baltic.Rd +++ b/man/gsw_SA_from_SP_Baltic.Rd @@ -7,7 +7,8 @@ gsw_SA_from_SP_Baltic(SP, longitude, latitude) } \arguments{ -\item{SP}{Practical Salinity (PSS-78) [ unitless ]} +\item{SP}{Practical Salinity (PSS-78) [ unitless ]. The valid range for most +`gsw` functions is from 2 to 42.} \item{longitude}{longitude in decimal degrees, positive to the east of Greenwich. (This is called \code{long} in the TEOS-10 Matlab code.)} @@ -31,8 +32,8 @@ converted to analogous matrices with \code{\link{expand.grid}}. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_SA_from_Sstar.Rd b/man/gsw_SA_from_Sstar.Rd index ed070a05..229ae72e 100644 --- a/man/gsw_SA_from_Sstar.Rd +++ b/man/gsw_SA_from_Sstar.Rd @@ -33,8 +33,8 @@ converted to analogous matrices with \code{\link{expand.grid}}. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -65,8 +65,8 @@ stopifnot(all.equal(SA, c(34.711724663585905, 34.891561223296009, 35.02559459869 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SA}()}, \code{\link{gsw_SP_from_SK}()}, diff --git a/man/gsw_SA_from_rho.Rd b/man/gsw_SA_from_rho.Rd index ace017f4..bb364926 100644 --- a/man/gsw_SA_from_rho.Rd +++ b/man/gsw_SA_from_rho.Rd @@ -9,7 +9,7 @@ gsw_SA_from_rho(rho, CT, p) \arguments{ \item{rho}{seawater density [ kg/m^3 ]} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +23,8 @@ Compute Absolute Salinity from Density, etc This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,28 +55,29 @@ stopifnot(all.equal(SA, c(34.712080120418108, 34.891723808488869, 35.02620225760 Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_SP_from_C.Rd b/man/gsw_SP_from_C.Rd index 22b06c5f..0cf6d927 100644 --- a/man/gsw_SP_from_C.Rd +++ b/man/gsw_SP_from_C.Rd @@ -23,8 +23,8 @@ Convert from Electrical Conductivity to Practical Salinity This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -54,8 +54,8 @@ stopifnot(all.equal(SP, c(20.009869599086951, 20.265511864874270, 22.9815130625 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_SA}()}, \code{\link{gsw_SP_from_SK}()}, diff --git a/man/gsw_SP_from_SA.Rd b/man/gsw_SP_from_SA.Rd index 6f2fdcd2..2761eba8 100644 --- a/man/gsw_SP_from_SA.Rd +++ b/man/gsw_SP_from_SA.Rd @@ -7,7 +7,8 @@ gsw_SP_from_SA(SA, p, longitude, latitude) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -36,8 +37,8 @@ return a flag indicating whether the location is in the ocean. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -68,8 +69,8 @@ stopifnot(all.equal(SP, c(34.548721553448317, 34.727477488096639, 34.86055487770 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SK}()}, diff --git a/man/gsw_SP_from_SK.Rd b/man/gsw_SP_from_SK.Rd index a9f7771e..bf670a39 100644 --- a/man/gsw_SP_from_SK.Rd +++ b/man/gsw_SP_from_SK.Rd @@ -27,8 +27,8 @@ stopifnot(all.equal(SP, c(34.548342096952908, 34.727295637119113, 34.86040984764 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SA}()}, diff --git a/man/gsw_SP_from_SR.Rd b/man/gsw_SP_from_SR.Rd index 4467eaeb..b8e4965f 100644 --- a/man/gsw_SP_from_SR.Rd +++ b/man/gsw_SP_from_SR.Rd @@ -19,8 +19,8 @@ Calculate Practical Salinity from Reference Salinity This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -48,8 +48,8 @@ stopifnot(all.equal(SP, c(34.386552667080714, 34.564513505458834, 34.69688929686 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SA}()}, diff --git a/man/gsw_SP_from_Sstar.Rd b/man/gsw_SP_from_Sstar.Rd index 52d61807..0f85f189 100644 --- a/man/gsw_SP_from_Sstar.Rd +++ b/man/gsw_SP_from_Sstar.Rd @@ -27,8 +27,8 @@ Practical Salinity from Preformed Salinity This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -59,8 +59,8 @@ stopifnot(all.equal(SP, c(34.548646570969929, 34.727538423586189, 34.86054950185 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SA}()}, diff --git a/man/gsw_SP_salinometer.Rd b/man/gsw_SP_salinometer.Rd index c38a31dc..43d0371d 100644 --- a/man/gsw_SP_salinometer.Rd +++ b/man/gsw_SP_salinometer.Rd @@ -24,8 +24,8 @@ of conductivity ratio and bath temperature. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_SR_from_SP.Rd b/man/gsw_SR_from_SP.Rd index ac64519e..1ced4225 100644 --- a/man/gsw_SR_from_SP.Rd +++ b/man/gsw_SR_from_SP.Rd @@ -7,7 +7,8 @@ gsw_SR_from_SP(SP) } \arguments{ -\item{SP}{Practical Salinity (PSS-78) [ unitless ]} +\item{SP}{Practical Salinity (PSS-78) [ unitless ]. The valid range for most +`gsw` functions is from 2 to 42.} } \value{ Reference Salinity [ g/kg ] @@ -19,8 +20,8 @@ Calculate Reference Salinity from Practical Salinity This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -48,8 +49,8 @@ stopifnot(all.equal(SR, c(34.711611927085727, 34.891255045714303, 35.02488219771 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SA}()}, diff --git a/man/gsw_Sstar_from_SA.Rd b/man/gsw_Sstar_from_SA.Rd index 43f65c7e..6b5e3af5 100644 --- a/man/gsw_Sstar_from_SA.Rd +++ b/man/gsw_Sstar_from_SA.Rd @@ -7,7 +7,8 @@ gsw_Sstar_from_SA(SA, p, longitude, latitude) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -33,8 +34,8 @@ converted to analogous matrices with \code{\link{expand.grid}}. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -65,8 +66,8 @@ stopifnot(all.equal(Sstar, c(34.711575335926490, 34.891138777337822, 35.02470540 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SA}()}, diff --git a/man/gsw_Sstar_from_SP.Rd b/man/gsw_Sstar_from_SP.Rd index 33595a31..4ca249ad 100644 --- a/man/gsw_Sstar_from_SP.Rd +++ b/man/gsw_Sstar_from_SP.Rd @@ -7,7 +7,8 @@ gsw_Sstar_from_SP(SP, p, longitude, latitude) } \arguments{ -\item{SP}{Practical Salinity (PSS-78) [ unitless ]} +\item{SP}{Practical Salinity (PSS-78) [ unitless ]. The valid range for most +`gsw` functions is from 2 to 42.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -33,8 +34,8 @@ converted to analogous matrices with \code{\link{expand.grid}}. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -65,8 +66,8 @@ stopifnot(all.equal(Sstar, c(34.711553680880769, 34.891161395333754, 35.02465026 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SA}()}, diff --git a/man/gsw_Turner_Rsubrho.Rd b/man/gsw_Turner_Rsubrho.Rd index 14fc77d0..0868187d 100644 --- a/man/gsw_Turner_Rsubrho.Rd +++ b/man/gsw_Turner_Rsubrho.Rd @@ -7,9 +7,10 @@ gsw_Turner_Rsubrho(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -24,8 +25,8 @@ Tu and density ratio Rrho are calculated at mid-point pressures, \code{p_mid}. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_adiabatic_lapse_rate_from_CT.Rd b/man/gsw_adiabatic_lapse_rate_from_CT.Rd index 96f56483..b731aa56 100644 --- a/man/gsw_adiabatic_lapse_rate_from_CT.Rd +++ b/man/gsw_adiabatic_lapse_rate_from_CT.Rd @@ -7,9 +7,10 @@ gsw_adiabatic_lapse_rate_from_CT(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Note that the unit is K/Pa; multiply by 1e4 to get the more useful K/dbar. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_adiabatic_lapse_rate_ice.Rd b/man/gsw_adiabatic_lapse_rate_ice.Rd index 3385a4ee..7eb31f5b 100644 --- a/man/gsw_adiabatic_lapse_rate_ice.Rd +++ b/man/gsw_adiabatic_lapse_rate_ice.Rd @@ -21,8 +21,8 @@ Note that the unit is K/Pa; multiply by 1e4 to get the more useful K/dbar. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_alpha.Rd b/man/gsw_alpha.Rd index 9a8704e2..673dce19 100644 --- a/man/gsw_alpha.Rd +++ b/man/gsw_alpha.Rd @@ -7,9 +7,10 @@ gsw_alpha(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -24,8 +25,8 @@ the 75-term equation for specific volume. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -60,24 +61,25 @@ Other things related to density: \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_alpha_on_beta.Rd b/man/gsw_alpha_on_beta.Rd index b31c6bea..5e4dd3bb 100644 --- a/man/gsw_alpha_on_beta.Rd +++ b/man/gsw_alpha_on_beta.Rd @@ -7,9 +7,10 @@ gsw_alpha_on_beta(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -24,8 +25,8 @@ using the 75-term equation for specific volume. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -57,27 +58,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_alpha_wrt_t_exact.Rd b/man/gsw_alpha_wrt_t_exact.Rd index e029298b..4dc56a39 100644 --- a/man/gsw_alpha_wrt_t_exact.Rd +++ b/man/gsw_alpha_wrt_t_exact.Rd @@ -7,7 +7,8 @@ gsw_alpha_wrt_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Thermal expansion coefficient with respect to in-situ temperature. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -57,27 +58,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_alpha_wrt_t_ice.Rd b/man/gsw_alpha_wrt_t_ice.Rd index 5ab33645..2656cda3 100644 --- a/man/gsw_alpha_wrt_t_ice.Rd +++ b/man/gsw_alpha_wrt_t_ice.Rd @@ -21,8 +21,8 @@ Thermal expansion coefficient of ice, with respect to in-situ temperature. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -53,27 +53,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_beta.Rd b/man/gsw_beta.Rd index b4e1368b..48930571 100644 --- a/man/gsw_beta.Rd +++ b/man/gsw_beta.Rd @@ -7,9 +7,10 @@ gsw_beta(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -24,8 +25,8 @@ the 75-term equation for specific volume. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -57,27 +58,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, \code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_beta_const_t_exact.Rd b/man/gsw_beta_const_t_exact.Rd index a8156f03..e4e5600a 100644 --- a/man/gsw_beta_const_t_exact.Rd +++ b/man/gsw_beta_const_t_exact.Rd @@ -7,7 +7,8 @@ gsw_beta_const_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Haline contraction coefficient at constant in-situ temperature. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -56,27 +57,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_cabbeling.Rd b/man/gsw_cabbeling.Rd index 30d3e65f..61825ab5 100644 --- a/man/gsw_cabbeling.Rd +++ b/man/gsw_cabbeling.Rd @@ -7,9 +7,10 @@ gsw_cabbeling(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Cabbeling coefficient (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_chem_potential_water_ice.Rd b/man/gsw_chem_potential_water_ice.Rd index b123231d..cf158848 100644 --- a/man/gsw_chem_potential_water_ice.Rd +++ b/man/gsw_chem_potential_water_ice.Rd @@ -21,8 +21,8 @@ Chemical Potential of Ice This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_chem_potential_water_t_exact.Rd b/man/gsw_chem_potential_water_t_exact.Rd index ebcb3450..2c479c81 100644 --- a/man/gsw_chem_potential_water_t_exact.Rd +++ b/man/gsw_chem_potential_water_t_exact.Rd @@ -7,7 +7,8 @@ gsw_chem_potential_water_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Chemical Potential of Water in Seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_cp_ice.Rd b/man/gsw_cp_ice.Rd index 4438b6d5..5f15bd16 100644 --- a/man/gsw_cp_ice.Rd +++ b/man/gsw_cp_ice.Rd @@ -21,8 +21,8 @@ Specific heat of ice This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_cp_t_exact.Rd b/man/gsw_cp_t_exact.Rd index 94fb4735..4c6ad446 100644 --- a/man/gsw_cp_t_exact.Rd +++ b/man/gsw_cp_t_exact.Rd @@ -7,7 +7,8 @@ gsw_cp_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Isobaric heat capacity This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_deltaSA_from_SP.Rd b/man/gsw_deltaSA_from_SP.Rd index afac57d4..6c1baa8d 100644 --- a/man/gsw_deltaSA_from_SP.Rd +++ b/man/gsw_deltaSA_from_SP.Rd @@ -7,7 +7,8 @@ gsw_deltaSA_from_SP(SP, p, longitude, latitude) } \arguments{ -\item{SP}{Practical Salinity (PSS-78) [ unitless ]} +\item{SP}{Practical Salinity (PSS-78) [ unitless ]. The valid range for most +`gsw` functions is from 2 to 42.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -27,8 +28,8 @@ Absolute Salinity Anomaly from Practical Salinity This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -59,8 +60,8 @@ stopifnot(all.equal(deltaSA, c(0.000167203365230, 0.000268836122231, 0.000665803 \seealso{ Other things related to salinity: \code{\link{gsw_C_from_SP}()}, -\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_SP}()}, +\code{\link{gsw_SA_from_SP_Baltic}()}, \code{\link{gsw_SA_from_Sstar}()}, \code{\link{gsw_SP_from_C}()}, \code{\link{gsw_SP_from_SA}()}, diff --git a/man/gsw_dilution_coefficient_t_exact.Rd b/man/gsw_dilution_coefficient_t_exact.Rd index 5ecb0a6d..70413dee 100644 --- a/man/gsw_dilution_coefficient_t_exact.Rd +++ b/man/gsw_dilution_coefficient_t_exact.Rd @@ -7,7 +7,8 @@ gsw_dilution_coefficient_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Dilution coefficient This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_dynamic_enthalpy.Rd b/man/gsw_dynamic_enthalpy.Rd index 1fd0f764..78adfa36 100644 --- a/man/gsw_dynamic_enthalpy.Rd +++ b/man/gsw_dynamic_enthalpy.Rd @@ -7,9 +7,10 @@ gsw_dynamic_enthalpy(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Dynamic enthalpy of seawater (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -54,22 +55,22 @@ stopifnot(all.equal(de/1000, c(0.097864698087770, 0.489161476686235, 1.220512192 \seealso{ Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_enthalpy.Rd b/man/gsw_enthalpy.Rd index ff9427f1..f9ac9ad0 100644 --- a/man/gsw_enthalpy.Rd +++ b/man/gsw_enthalpy.Rd @@ -7,9 +7,10 @@ gsw_enthalpy(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Specific enthalpy of seawater (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -57,19 +58,19 @@ Other things related to enthalpy: \code{\link{gsw_dynamic_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_enthalpy_CT_exact.Rd b/man/gsw_enthalpy_CT_exact.Rd index bebca847..7347c345 100644 --- a/man/gsw_enthalpy_CT_exact.Rd +++ b/man/gsw_enthalpy_CT_exact.Rd @@ -7,9 +7,10 @@ gsw_enthalpy_CT_exact(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Seawater Specific Enthalpy in terms of Conservative Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,21 +56,21 @@ stopifnot(all.equal(e/1e5, c(1.151031813321767, 1.140146925586514, 0.92180013178 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_enthalpy_diff.Rd b/man/gsw_enthalpy_diff.Rd index e3002d08..794132de 100644 --- a/man/gsw_enthalpy_diff.Rd +++ b/man/gsw_enthalpy_diff.Rd @@ -7,9 +7,10 @@ gsw_enthalpy_diff(SA, CT, p_shallow, p_deep) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p_shallow}{pressure at a shallower depth [ dbar ]} @@ -25,8 +26,8 @@ Specific enthalpy difference [ J/kg ]. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -58,21 +59,21 @@ stopifnot(all.equal(ed/1e2, c(9.784180644568052, 9.780195056105020, 9.7595877005 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_enthalpy_first_derivatives.Rd b/man/gsw_enthalpy_first_derivatives.Rd index a10b3ecc..7f10b50d 100644 --- a/man/gsw_enthalpy_first_derivatives.Rd +++ b/man/gsw_enthalpy_first_derivatives.Rd @@ -7,9 +7,10 @@ gsw_enthalpy_first_derivatives(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -25,8 +26,8 @@ First Derivatives of Enthalpy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -59,21 +60,21 @@ stopifnot(all.equal(d$h_CT/1e3, c(3.991899705530481, 3.992025640520101, 3.992210 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, \code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_enthalpy_first_derivatives_CT_exact.Rd b/man/gsw_enthalpy_first_derivatives_CT_exact.Rd index 5b0f6b17..f4168cb3 100644 --- a/man/gsw_enthalpy_first_derivatives_CT_exact.Rd +++ b/man/gsw_enthalpy_first_derivatives_CT_exact.Rd @@ -7,9 +7,10 @@ gsw_enthalpy_first_derivatives_CT_exact(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -25,8 +26,8 @@ First Derivatives of Enthalpy wrt CT This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -69,21 +70,21 @@ stopifnot(all.equal(d$h_CT/1e3, c(3.991899712269790, 3.992025674159605, 3.992210 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_enthalpy_ice.Rd b/man/gsw_enthalpy_ice.Rd index 70f00b4d..0ce4f4cf 100644 --- a/man/gsw_enthalpy_ice.Rd +++ b/man/gsw_enthalpy_ice.Rd @@ -21,8 +21,8 @@ Specific enthalpy of ice [ J/kg ]. Note that this is a negative quantity. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -52,21 +52,21 @@ stopifnot(all.equal(se/1e5, c(-3.554414597446597, -3.603380857687490, -3.5830898 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_enthalpy_second_derivatives.Rd b/man/gsw_enthalpy_second_derivatives.Rd index 5d54bdcb..d9452570 100644 --- a/man/gsw_enthalpy_second_derivatives.Rd +++ b/man/gsw_enthalpy_second_derivatives.Rd @@ -7,9 +7,10 @@ gsw_enthalpy_second_derivatives(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -27,8 +28,8 @@ Second Derivatives of Enthalpy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_enthalpy_second_derivatives_CT_exact.Rd b/man/gsw_enthalpy_second_derivatives_CT_exact.Rd index ce7d73b3..b769f7a9 100644 --- a/man/gsw_enthalpy_second_derivatives_CT_exact.Rd +++ b/man/gsw_enthalpy_second_derivatives_CT_exact.Rd @@ -7,9 +7,10 @@ gsw_enthalpy_second_derivatives_CT_exact(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -27,8 +28,8 @@ Second Derivatives of Enthalpy (exact) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_enthalpy_t_exact.Rd b/man/gsw_enthalpy_t_exact.Rd index 26f4b0d3..896e5083 100644 --- a/man/gsw_enthalpy_t_exact.Rd +++ b/man/gsw_enthalpy_t_exact.Rd @@ -7,7 +7,8 @@ gsw_enthalpy_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Seawater Specific Enthalpy in terms of in-situ Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,21 +56,21 @@ stopifnot(all.equal(e/1e5, c(1.151032604783763, 1.140148036012021, 0.92179920931 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_entropy_first_derivatives.Rd b/man/gsw_entropy_first_derivatives.Rd index e1e12b31..d2cb8a40 100644 --- a/man/gsw_entropy_first_derivatives.Rd +++ b/man/gsw_entropy_first_derivatives.Rd @@ -7,9 +7,10 @@ gsw_entropy_first_derivatives(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ a list containing \code{eta_SA} [ (J/(kg*degC) / (g/kg) ], @@ -23,8 +24,8 @@ First Derivatives of Entropy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_entropy_from_pt.Rd b/man/gsw_entropy_from_pt.Rd index 1aaf3544..bc459ff8 100644 --- a/man/gsw_entropy_from_pt.Rd +++ b/man/gsw_entropy_from_pt.Rd @@ -7,7 +7,8 @@ gsw_entropy_from_pt(SA, pt) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{pt}{potential temperature (ITS-90) [ degC ]} } @@ -22,8 +23,8 @@ Potential Temperature. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_entropy_from_t.Rd b/man/gsw_entropy_from_t.Rd index 52d115f4..42d31a45 100644 --- a/man/gsw_entropy_from_t.Rd +++ b/man/gsw_entropy_from_t.Rd @@ -7,7 +7,8 @@ gsw_entropy_from_t(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -24,8 +25,8 @@ temperature and pressure. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_entropy_ice.Rd b/man/gsw_entropy_ice.Rd index dd979b89..e2ab1669 100644 --- a/man/gsw_entropy_ice.Rd +++ b/man/gsw_entropy_ice.Rd @@ -21,8 +21,8 @@ Entropy of ice This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_entropy_second_derivatives.Rd b/man/gsw_entropy_second_derivatives.Rd index 7b733a8d..1be34dbc 100644 --- a/man/gsw_entropy_second_derivatives.Rd +++ b/man/gsw_entropy_second_derivatives.Rd @@ -7,9 +7,10 @@ gsw_entropy_second_derivatives(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ A list containing \code{eta_SA_SA} [ (J/(K*kg))/(g/kg)^2 ], the second derivative of @@ -25,8 +26,8 @@ Second Derivatives of Entropy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_frazil_properties.Rd b/man/gsw_frazil_properties.Rd index 15cba7ba..3a4aced8 100644 --- a/man/gsw_frazil_properties.Rd +++ b/man/gsw_frazil_properties.Rd @@ -24,8 +24,8 @@ based on bulk Absolute Salinity, bulk enthalpy, and pressure This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_frazil_properties_potential.Rd b/man/gsw_frazil_properties_potential.Rd index 4fcf1e98..592f2a0c 100644 --- a/man/gsw_frazil_properties_potential.Rd +++ b/man/gsw_frazil_properties_potential.Rd @@ -24,8 +24,8 @@ based on bulk Absolute Salinity, bulk potential enthalpy, and pressure This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -60,21 +60,21 @@ stopifnot(all.equal(r$w_Ih_final, c(0.112190640891586, 0.113150826758543, 0.1117 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, \code{\link{gsw_frazil_properties_potential_poly}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_frazil_properties_potential_poly.Rd b/man/gsw_frazil_properties_potential_poly.Rd index e8eff703..4960f551 100644 --- a/man/gsw_frazil_properties_potential_poly.Rd +++ b/man/gsw_frazil_properties_potential_poly.Rd @@ -24,8 +24,8 @@ based on bulk Absolute Salinity, bulk potential enthalpy, and pressure This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -60,21 +60,21 @@ stopifnot(all.equal(r$w_Ih_final, c(0.112190777010854, 0.113150823111566, 0.1117 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_frazil_ratios_adiabatic.Rd b/man/gsw_frazil_ratios_adiabatic.Rd index 3e24c155..425aa837 100644 --- a/man/gsw_frazil_ratios_adiabatic.Rd +++ b/man/gsw_frazil_ratios_adiabatic.Rd @@ -7,7 +7,8 @@ gsw_frazil_ratios_adiabatic(SA, p, w_Ih) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -25,8 +26,8 @@ the mixture of seawater and ice. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_frazil_ratios_adiabatic_poly.Rd b/man/gsw_frazil_ratios_adiabatic_poly.Rd index cb4216a2..8e7e962c 100644 --- a/man/gsw_frazil_ratios_adiabatic_poly.Rd +++ b/man/gsw_frazil_ratios_adiabatic_poly.Rd @@ -7,7 +7,8 @@ gsw_frazil_ratios_adiabatic_poly(SA, p, w_Ih) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -25,8 +26,8 @@ the mixture of seawater and ice. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_geo_strf_dyn_height.Rd b/man/gsw_geo_strf_dyn_height.Rd index 954bb695..0799144f 100644 --- a/man/gsw_geo_strf_dyn_height.Rd +++ b/man/gsw_geo_strf_dyn_height.Rd @@ -7,9 +7,10 @@ gsw_geo_strf_dyn_height(SA, CT, p, p_ref = 0) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -50,8 +51,8 @@ more on this topic. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_geo_strf_dyn_height_1.Rd b/man/gsw_geo_strf_dyn_height_1.Rd index 079f8b2f..f808db04 100644 --- a/man/gsw_geo_strf_dyn_height_1.Rd +++ b/man/gsw_geo_strf_dyn_height_1.Rd @@ -7,9 +7,10 @@ gsw_geo_strf_dyn_height_1(SA, CT, p, p_ref = 0, max_dp = 1, interp_method = 2) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -48,8 +49,8 @@ of zeros is returned, in accordance with the underlying C code. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_geo_strf_dyn_height_pc.Rd b/man/gsw_geo_strf_dyn_height_pc.Rd index 274f50cd..ccaef47d 100644 --- a/man/gsw_geo_strf_dyn_height_pc.Rd +++ b/man/gsw_geo_strf_dyn_height_pc.Rd @@ -7,9 +7,10 @@ gsw_geo_strf_dyn_height_pc(SA, CT, delta_p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{delta_p}{difference in sea pressure between the deep and shallow limits of layers within which \code{SA} and \code{CT} are @@ -29,8 +30,8 @@ Geostrophic Dynamic Height Anomaly (Piecewise-Constant Profile) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_gibbs.Rd b/man/gsw_gibbs.Rd index 88fc6ae0..a429251a 100644 --- a/man/gsw_gibbs.Rd +++ b/man/gsw_gibbs.Rd @@ -13,7 +13,8 @@ gsw_gibbs(ns, nt, np, SA, t, p = 0) \item{np}{An integer, the order of the \code{p} derivative. Must be 0, 1, or 2.} -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -31,8 +32,8 @@ Gibbs Energy of Seawater, and its Derivatives This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_gibbs_ice.Rd b/man/gsw_gibbs_ice.Rd index 1776e433..45ab54f8 100644 --- a/man/gsw_gibbs_ice.Rd +++ b/man/gsw_gibbs_ice.Rd @@ -27,8 +27,8 @@ Gibbs Energy of Ice, and its Derivatives This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_grav.Rd b/man/gsw_grav.Rd index 38a1f8eb..dd1b5598 100644 --- a/man/gsw_grav.Rd +++ b/man/gsw_grav.Rd @@ -22,8 +22,8 @@ Gravitational Acceleration This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_ice_fraction_to_freeze_seawater.Rd b/man/gsw_ice_fraction_to_freeze_seawater.Rd index d3a7cfea..22095c6c 100644 --- a/man/gsw_ice_fraction_to_freeze_seawater.Rd +++ b/man/gsw_ice_fraction_to_freeze_seawater.Rd @@ -7,9 +7,10 @@ gsw_ice_fraction_to_freeze_seawater(SA, CT, p, t_Ih) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -25,8 +26,8 @@ Ice Fraction to Cool Seawater to Freezing This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_infunnel.Rd b/man/gsw_infunnel.Rd new file mode 100644 index 00000000..a5e2d04b --- /dev/null +++ b/man/gsw_infunnel.Rd @@ -0,0 +1,67 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/gsw.R +\name{gsw_infunnel} +\alias{gsw_infunnel} +\title{Determine whether a point is inside the 'funnel' of acceptable values} +\usage{ +gsw_infunnel(SA, CT, p) +} +\arguments{ +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} + +\item{CT}{Conservative Temperature [ degC ].} + +\item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} +} +\value{ +a logical value indicating whether the given +point is inside the funnel of acceptable values. +} +\description{ +This function determines whether a given hydrographic value lies what +the TEOS-10 literature calls a "funnel" of values that lead to acceptably +accurate computation of specific volume. For more details, consult the +TEOS-10 literature, perhaps starting with the materials referred to in the +webpage cited in the \sQuote{References} section. +} +\examples{ +library(gsw) +gsw_infunnel(35, 10, 100) # TRUE +gsw_infunnel(45, 10, 100) # FALSE: too salty +gsw_infunnel(35, -4, 100) # FALSE: below freezing + +} +\references{ +\url{https://www.teos-10.org/pubs/gsw/html/gsw_infunnel.html} +} +\seealso{ +Other things related to density: +\code{\link{gsw_CT_from_rho}()}, +\code{\link{gsw_CT_maxdensity}()}, +\code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, +\code{\link{gsw_alpha_on_beta}()}, +\code{\link{gsw_alpha_wrt_t_exact}()}, +\code{\link{gsw_alpha_wrt_t_ice}()}, +\code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, +\code{\link{gsw_rho_alpha_beta}()}, +\code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, +\code{\link{gsw_rho_ice}()}, +\code{\link{gsw_rho_t_exact}()}, +\code{\link{gsw_sigma0}()}, +\code{\link{gsw_sigma1}()}, +\code{\link{gsw_sigma2}()}, +\code{\link{gsw_sigma3}()}, +\code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, +\code{\link{gsw_specvol_alpha_beta}()}, +\code{\link{gsw_specvol_anom_standard}()}, +\code{\link{gsw_specvol_ice}()}, +\code{\link{gsw_specvol_t_exact}()} +} +\concept{things related to density} diff --git a/man/gsw_internal_energy.Rd b/man/gsw_internal_energy.Rd index 3d3b5700..3e72a7df 100644 --- a/man/gsw_internal_energy.Rd +++ b/man/gsw_internal_energy.Rd @@ -7,9 +7,10 @@ gsw_internal_energy(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Specific Internal Energy of Seawater (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_internal_energy_ice.Rd b/man/gsw_internal_energy_ice.Rd index 1b7815c9..4199d17d 100644 --- a/man/gsw_internal_energy_ice.Rd +++ b/man/gsw_internal_energy_ice.Rd @@ -21,8 +21,8 @@ Specific Internal Energy of Ice (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_kappa.Rd b/man/gsw_kappa.Rd index 584dfe3a..228e64f8 100644 --- a/man/gsw_kappa.Rd +++ b/man/gsw_kappa.Rd @@ -7,9 +7,10 @@ gsw_kappa(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Isentropic Compressibility of Seawater (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_kappa_const_t_ice.Rd b/man/gsw_kappa_const_t_ice.Rd index 27d59a4d..adffba9c 100644 --- a/man/gsw_kappa_const_t_ice.Rd +++ b/man/gsw_kappa_const_t_ice.Rd @@ -21,8 +21,8 @@ Calculate isothermal compressibility of ice, in 1/Pa. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -50,8 +50,8 @@ stopifnot(all.equal(kappa*1e9, c(0.115874753261484, 0.115384948953145, 0.1154422 } \seealso{ Other things related to compressibility: +\code{\link{gsw_kappa}()}, \code{\link{gsw_kappa_ice}()}, -\code{\link{gsw_kappa_t_exact}()}, -\code{\link{gsw_kappa}()} +\code{\link{gsw_kappa_t_exact}()} } \concept{things related to compressibility} diff --git a/man/gsw_kappa_ice.Rd b/man/gsw_kappa_ice.Rd index d460c4cf..f522b3f7 100644 --- a/man/gsw_kappa_ice.Rd +++ b/man/gsw_kappa_ice.Rd @@ -21,8 +21,8 @@ Calculate isentropic compressibility of ice, in 1/Pa. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -50,8 +50,8 @@ stopifnot(all.equal(kappa*1e9, c(0.112495239053936, 0.112070687842183, 0.1121190 } \seealso{ Other things related to compressibility: +\code{\link{gsw_kappa}()}, \code{\link{gsw_kappa_const_t_ice}()}, -\code{\link{gsw_kappa_t_exact}()}, -\code{\link{gsw_kappa}()} +\code{\link{gsw_kappa_t_exact}()} } \concept{things related to compressibility} diff --git a/man/gsw_kappa_t_exact.Rd b/man/gsw_kappa_t_exact.Rd index dd884a35..484db09e 100644 --- a/man/gsw_kappa_t_exact.Rd +++ b/man/gsw_kappa_t_exact.Rd @@ -7,7 +7,8 @@ gsw_kappa_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Isentropic compressibility of seawater (exact) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -54,8 +55,8 @@ stopifnot(all.equal(kappa*1e9, } \seealso{ Other things related to compressibility: +\code{\link{gsw_kappa}()}, \code{\link{gsw_kappa_const_t_ice}()}, -\code{\link{gsw_kappa_ice}()}, -\code{\link{gsw_kappa}()} +\code{\link{gsw_kappa_ice}()} } \concept{things related to compressibility} diff --git a/man/gsw_latentheat_evap_CT.Rd b/man/gsw_latentheat_evap_CT.Rd index 53a6c5c7..ba09bbe7 100644 --- a/man/gsw_latentheat_evap_CT.Rd +++ b/man/gsw_latentheat_evap_CT.Rd @@ -7,9 +7,10 @@ gsw_latentheat_evap_CT(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ latent heat of evaporation [ J/kg ] @@ -21,8 +22,8 @@ Latent heat of evaporation This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_latentheat_evap_t.Rd b/man/gsw_latentheat_evap_t.Rd index a5e6f60b..b0f59bd4 100644 --- a/man/gsw_latentheat_evap_t.Rd +++ b/man/gsw_latentheat_evap_t.Rd @@ -7,7 +7,8 @@ gsw_latentheat_evap_t(SA, t) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} } @@ -21,8 +22,8 @@ Latent heat of evaporation This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_latentheat_melting.Rd b/man/gsw_latentheat_melting.Rd index 9b3ab390..05e390dc 100644 --- a/man/gsw_latentheat_melting.Rd +++ b/man/gsw_latentheat_melting.Rd @@ -7,7 +7,8 @@ gsw_latentheat_melting(SA, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -21,8 +22,8 @@ Latent Heat of Melting This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_melting_ice_SA_CT_ratio.Rd b/man/gsw_melting_ice_SA_CT_ratio.Rd index 66e66fda..94097277 100644 --- a/man/gsw_melting_ice_SA_CT_ratio.Rd +++ b/man/gsw_melting_ice_SA_CT_ratio.Rd @@ -7,9 +7,10 @@ gsw_melting_ice_SA_CT_ratio(SA, CT, p, t_Ih) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -25,8 +26,8 @@ Calculate d(SA)/d(CT) for Ice Melting in Seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_melting_ice_SA_CT_ratio_poly.Rd b/man/gsw_melting_ice_SA_CT_ratio_poly.Rd index 5cef4f40..8d1928cb 100644 --- a/man/gsw_melting_ice_SA_CT_ratio_poly.Rd +++ b/man/gsw_melting_ice_SA_CT_ratio_poly.Rd @@ -7,9 +7,10 @@ gsw_melting_ice_SA_CT_ratio_poly(SA, CT, p, t_Ih) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -25,8 +26,8 @@ Calculate d(SA)/d(CT) for Ice Melting in Seawater (Polynomial version) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_melting_ice_equilibrium_SA_CT_ratio.Rd b/man/gsw_melting_ice_equilibrium_SA_CT_ratio.Rd index 9465a768..fd33e660 100644 --- a/man/gsw_melting_ice_equilibrium_SA_CT_ratio.Rd +++ b/man/gsw_melting_ice_equilibrium_SA_CT_ratio.Rd @@ -7,7 +7,8 @@ gsw_melting_ice_equilibrium_SA_CT_ratio(SA, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -21,8 +22,8 @@ Calculate d(SA)/d(CT) for Ice Melting in near-freezing Seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_melting_ice_equilibrium_SA_CT_ratio_poly.Rd b/man/gsw_melting_ice_equilibrium_SA_CT_ratio_poly.Rd index cfc830c1..4f4a047b 100644 --- a/man/gsw_melting_ice_equilibrium_SA_CT_ratio_poly.Rd +++ b/man/gsw_melting_ice_equilibrium_SA_CT_ratio_poly.Rd @@ -7,7 +7,8 @@ gsw_melting_ice_equilibrium_SA_CT_ratio_poly(SA, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -21,8 +22,8 @@ Calculate d(SA)/d(CT) for Ice Melting in near-freezing Seawater (Polynomial vers This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_melting_ice_into_seawater.Rd b/man/gsw_melting_ice_into_seawater.Rd index abf4b8e1..c324d8af 100644 --- a/man/gsw_melting_ice_into_seawater.Rd +++ b/man/gsw_melting_ice_into_seawater.Rd @@ -7,9 +7,10 @@ gsw_melting_ice_into_seawater(SA, CT, p, w_Ih, t_Ih) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -27,8 +28,8 @@ Calculate properties related to ice melting in seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_melting_seaice_into_seawater.Rd b/man/gsw_melting_seaice_into_seawater.Rd index d6b23d01..3776841a 100644 --- a/man/gsw_melting_seaice_into_seawater.Rd +++ b/man/gsw_melting_seaice_into_seawater.Rd @@ -7,9 +7,10 @@ gsw_melting_seaice_into_seawater(SA, CT, p, w_seaice, SA_seaice, t_seaice) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -29,8 +30,8 @@ Calculate properties related to seaice melting in seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_p_from_z.Rd b/man/gsw_p_from_z.Rd index 97dee439..9cc31bf7 100644 --- a/man/gsw_p_from_z.Rd +++ b/man/gsw_p_from_z.Rd @@ -32,8 +32,8 @@ Pressure from height (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pot_enthalpy_from_pt_ice.Rd b/man/gsw_pot_enthalpy_from_pt_ice.Rd index 49c9d2e8..f43a2392 100644 --- a/man/gsw_pot_enthalpy_from_pt_ice.Rd +++ b/man/gsw_pot_enthalpy_from_pt_ice.Rd @@ -19,8 +19,8 @@ Potential Enthalpy of Ice This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -49,21 +49,21 @@ stopifnot(all.equal(e/1e5, c(-3.555459449611868, -3.608607069998877, -3.59615389 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_pot_enthalpy_from_pt_ice_poly.Rd b/man/gsw_pot_enthalpy_from_pt_ice_poly.Rd index 688d9a56..0a825f62 100644 --- a/man/gsw_pot_enthalpy_from_pt_ice_poly.Rd +++ b/man/gsw_pot_enthalpy_from_pt_ice_poly.Rd @@ -19,8 +19,8 @@ Potential Enthalpy of Ice (Polynomial version) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -49,21 +49,21 @@ stopifnot(all.equal(e/1e5, c(-3.555459482216265, -3.608607100959428, -3.59615392 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_pot_enthalpy_ice_freezing.Rd b/man/gsw_pot_enthalpy_ice_freezing.Rd index 86ce7aec..0bddc602 100644 --- a/man/gsw_pot_enthalpy_ice_freezing.Rd +++ b/man/gsw_pot_enthalpy_ice_freezing.Rd @@ -7,7 +7,8 @@ gsw_pot_enthalpy_ice_freezing(SA, p, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -23,8 +24,8 @@ Potential Enthalpy of Ice at Freezing Point This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -47,7 +48,7 @@ which is present in the Matlab source, and so that argument is ignored here. 2. The R code does not reproduce the check values stated at \url{http://www.teos-10.org/pubs/gsw/html/gsw_pot_enthalpy_ice_freezing.html}. Those -values are incorporated in the test provided in \dQuote{Examples}, so that test +values are incorporated in the test provided in \sQuote{Examples}, so that test is not performed during build tests. See https://github.com/TEOS-10/GSW-R/issues/27. } @@ -68,21 +69,21 @@ stopifnot(all.equal(e/1e5, c(-3.373409558967978, -3.374434164002012, -3.37611753 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_pot_enthalpy_ice_freezing_first_derivatives.Rd b/man/gsw_pot_enthalpy_ice_freezing_first_derivatives.Rd index 384f1b68..3d54ed48 100644 --- a/man/gsw_pot_enthalpy_ice_freezing_first_derivatives.Rd +++ b/man/gsw_pot_enthalpy_ice_freezing_first_derivatives.Rd @@ -7,7 +7,8 @@ gsw_pot_enthalpy_ice_freezing_first_derivatives(SA, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -25,8 +26,8 @@ First Derivatives of Potential Enthalpy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pot_enthalpy_ice_freezing_first_derivatives_poly.Rd b/man/gsw_pot_enthalpy_ice_freezing_first_derivatives_poly.Rd index 47dfe55a..28bef462 100644 --- a/man/gsw_pot_enthalpy_ice_freezing_first_derivatives_poly.Rd +++ b/man/gsw_pot_enthalpy_ice_freezing_first_derivatives_poly.Rd @@ -7,7 +7,8 @@ gsw_pot_enthalpy_ice_freezing_first_derivatives_poly(SA, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -25,8 +26,8 @@ First Derivatives of Potential Enthalpy (Polynomial version) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pot_enthalpy_ice_freezing_poly.Rd b/man/gsw_pot_enthalpy_ice_freezing_poly.Rd index b00ea64b..5a923308 100644 --- a/man/gsw_pot_enthalpy_ice_freezing_poly.Rd +++ b/man/gsw_pot_enthalpy_ice_freezing_poly.Rd @@ -7,7 +7,8 @@ gsw_pot_enthalpy_ice_freezing_poly(SA, p, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -23,8 +24,8 @@ Potential Enthalpy of Ice at Freezing Point (Polynomial version) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,21 +56,21 @@ stopifnot(all.equal(e/1e5, c(-3.373370858777002, -3.374395733068549, -3.37607950 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_pot_rho_t_exact.Rd b/man/gsw_pot_rho_t_exact.Rd index a39cddb2..6a7662ed 100644 --- a/man/gsw_pot_rho_t_exact.Rd +++ b/man/gsw_pot_rho_t_exact.Rd @@ -7,7 +7,8 @@ gsw_pot_rho_t_exact(SA, t, p, p_ref) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -25,8 +26,8 @@ Potential density This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -59,27 +60,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_pressure_coefficient_ice.Rd b/man/gsw_pressure_coefficient_ice.Rd index 918999e0..a5d85575 100644 --- a/man/gsw_pressure_coefficient_ice.Rd +++ b/man/gsw_pressure_coefficient_ice.Rd @@ -21,8 +21,8 @@ Pressure Coefficient for Ice This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pressure_freezing_CT.Rd b/man/gsw_pressure_freezing_CT.Rd index 86b2c886..7a71654f 100644 --- a/man/gsw_pressure_freezing_CT.Rd +++ b/man/gsw_pressure_freezing_CT.Rd @@ -7,9 +7,10 @@ gsw_pressure_freezing_CT(SA, CT, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{saturation_fraction}{fraction of air in water [unitless]} } @@ -23,8 +24,8 @@ Pressure at which Seawater Freezes This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pt0_from_t.Rd b/man/gsw_pt0_from_t.Rd index f66d2bd0..6fcb5ea4 100644 --- a/man/gsw_pt0_from_t.Rd +++ b/man/gsw_pt0_from_t.Rd @@ -7,7 +7,8 @@ gsw_pt0_from_t(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Potential temperature referenced to the surface This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pt0_from_t_ice.Rd b/man/gsw_pt0_from_t_ice.Rd index e0fb6953..719fe0ab 100644 --- a/man/gsw_pt0_from_t_ice.Rd +++ b/man/gsw_pt0_from_t_ice.Rd @@ -21,8 +21,8 @@ Potential Temperature of Ice Referenced to the Surface This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pt_first_derivatives.Rd b/man/gsw_pt_first_derivatives.Rd index 30501701..f2c3705b 100644 --- a/man/gsw_pt_first_derivatives.Rd +++ b/man/gsw_pt_first_derivatives.Rd @@ -7,9 +7,10 @@ gsw_pt_first_derivatives(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ A list containing \code{pt_SA} [ K/(g/kg) ], the derivative of @@ -24,8 +25,8 @@ First Derivatives of Potential Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pt_from_CT.Rd b/man/gsw_pt_from_CT.Rd index b3716710..f19024dc 100644 --- a/man/gsw_pt_from_CT.Rd +++ b/man/gsw_pt_from_CT.Rd @@ -7,9 +7,10 @@ gsw_pt_from_CT(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ potential temperature [ degC ] @@ -21,8 +22,8 @@ Potential temperature from Conservative Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pt_from_entropy.Rd b/man/gsw_pt_from_entropy.Rd index 3b10bda6..8652c79c 100644 --- a/man/gsw_pt_from_entropy.Rd +++ b/man/gsw_pt_from_entropy.Rd @@ -7,7 +7,8 @@ gsw_pt_from_entropy(SA, entropy) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{entropy}{specific entropy [ J/(degC*kg) ]} } @@ -21,8 +22,8 @@ Potential Temperature from Entropy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pt_from_pot_enthalpy_ice.Rd b/man/gsw_pt_from_pot_enthalpy_ice.Rd index 66d1ae8e..e62c48a1 100644 --- a/man/gsw_pt_from_pot_enthalpy_ice.Rd +++ b/man/gsw_pt_from_pot_enthalpy_ice.Rd @@ -19,8 +19,8 @@ Potential Temperature from Potential Enthalpy of Ice This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -49,21 +49,21 @@ stopifnot(all.equal(pt, c(-10.733087588125384, -13.167397822300588, -12.15420589 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_pt_from_pot_enthalpy_ice_poly.Rd b/man/gsw_pt_from_pot_enthalpy_ice_poly.Rd index 2560ac55..6b3b37b4 100644 --- a/man/gsw_pt_from_pot_enthalpy_ice_poly.Rd +++ b/man/gsw_pt_from_pot_enthalpy_ice_poly.Rd @@ -19,8 +19,8 @@ Potential Temperature from Potential Enthalpy of Ice (Polynomial version) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -49,21 +49,21 @@ stopifnot(all.equal(pt, c(-10.733085986035007, -13.167396204945987, -12.15420413 Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, -\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()}, -\code{\link{gsw_specvol_first_derivatives}()} +\code{\link{gsw_specvol_first_derivatives}()}, +\code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_pt_from_t.Rd b/man/gsw_pt_from_t.Rd index b7fae53f..492df073 100644 --- a/man/gsw_pt_from_t.Rd +++ b/man/gsw_pt_from_t.Rd @@ -7,7 +7,8 @@ gsw_pt_from_t(SA, t, p, p_ref = 0) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -25,8 +26,8 @@ Potential Temperature from in-situ Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pt_from_t_ice.Rd b/man/gsw_pt_from_t_ice.Rd index 4c70ccb3..3fbb62de 100644 --- a/man/gsw_pt_from_t_ice.Rd +++ b/man/gsw_pt_from_t_ice.Rd @@ -23,8 +23,8 @@ Potential Temperature of Ice from in-situ Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_pt_second_derivatives.Rd b/man/gsw_pt_second_derivatives.Rd index 1ec3c3b2..7d25d50e 100644 --- a/man/gsw_pt_second_derivatives.Rd +++ b/man/gsw_pt_second_derivatives.Rd @@ -7,9 +7,10 @@ gsw_pt_second_derivatives(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ A list containing \code{pt_SA_SA} [ K/(g/kg)^2 ], the second derivative of @@ -26,8 +27,8 @@ Second Derivatives of Potential Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_rho.Rd b/man/gsw_rho.Rd index 90c2bfb3..ba3ebae9 100644 --- a/man/gsw_rho.Rd +++ b/man/gsw_rho.Rd @@ -7,9 +7,10 @@ gsw_rho(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ In-situ density, using the 75-term equation for specific volume. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -56,16 +57,17 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, \code{\link{gsw_sigma0}()}, @@ -73,10 +75,10 @@ Other things related to density: \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_rho_alpha_beta.Rd b/man/gsw_rho_alpha_beta.Rd index 2b6321ee..db2efd62 100644 --- a/man/gsw_rho_alpha_beta.Rd +++ b/man/gsw_rho_alpha_beta.Rd @@ -7,9 +7,10 @@ gsw_rho_alpha_beta(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -27,8 +28,8 @@ the haline contraction coefficient (with respect to Absolute Salinity), using th This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -64,27 +65,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_rho_first_derivatives.Rd b/man/gsw_rho_first_derivatives.Rd index f1e9c254..a9f71978 100644 --- a/man/gsw_rho_first_derivatives.Rd +++ b/man/gsw_rho_first_derivatives.Rd @@ -7,9 +7,10 @@ gsw_rho_first_derivatives(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Density First Derivatives wrt SA, CT and p (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -60,27 +61,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, \code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_rho_first_derivatives_wrt_enthalpy.Rd b/man/gsw_rho_first_derivatives_wrt_enthalpy.Rd index ffb1570b..70689b12 100644 --- a/man/gsw_rho_first_derivatives_wrt_enthalpy.Rd +++ b/man/gsw_rho_first_derivatives_wrt_enthalpy.Rd @@ -7,9 +7,10 @@ gsw_rho_first_derivatives_wrt_enthalpy(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -24,8 +25,8 @@ Density First Derivatives wrt enthalpy (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -61,27 +62,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, \code{\link{gsw_rho_first_derivatives}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_rho_ice.Rd b/man/gsw_rho_ice.Rd index 67b0b5f9..88ef330e 100644 --- a/man/gsw_rho_ice.Rd +++ b/man/gsw_rho_ice.Rd @@ -21,8 +21,8 @@ In-situ density of ice [kg/m^3] This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -53,27 +53,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_rho_second_derivatives.Rd b/man/gsw_rho_second_derivatives.Rd index e1180a52..d14d1eb5 100644 --- a/man/gsw_rho_second_derivatives.Rd +++ b/man/gsw_rho_second_derivatives.Rd @@ -7,9 +7,10 @@ gsw_rho_second_derivatives(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -28,8 +29,8 @@ Second Derivatives of Density This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_rho_second_derivatives_wrt_enthalpy.Rd b/man/gsw_rho_second_derivatives_wrt_enthalpy.Rd index 10ddd655..a595e434 100644 --- a/man/gsw_rho_second_derivatives_wrt_enthalpy.Rd +++ b/man/gsw_rho_second_derivatives_wrt_enthalpy.Rd @@ -7,9 +7,10 @@ gsw_rho_second_derivatives_wrt_enthalpy(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -28,8 +29,8 @@ Second Derivatives of Density wrt Enthalpy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_rho_t_exact.Rd b/man/gsw_rho_t_exact.Rd index 723fdc98..cb126400 100644 --- a/man/gsw_rho_t_exact.Rd +++ b/man/gsw_rho_t_exact.Rd @@ -7,7 +7,8 @@ gsw_rho_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ In-situ Density of Seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -56,27 +57,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_seaice_fraction_to_freeze_seawater.Rd b/man/gsw_seaice_fraction_to_freeze_seawater.Rd index 927ecff6..298c7e43 100644 --- a/man/gsw_seaice_fraction_to_freeze_seawater.Rd +++ b/man/gsw_seaice_fraction_to_freeze_seawater.Rd @@ -7,9 +7,10 @@ gsw_seaice_fraction_to_freeze_seawater(SA, CT, p, SA_seaice, t_seaice) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -27,8 +28,8 @@ Sea ice Fraction to Cool Seawater to Freezing This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_sigma0.Rd b/man/gsw_sigma0.Rd index 9179edc8..2a212572 100644 --- a/man/gsw_sigma0.Rd +++ b/man/gsw_sigma0.Rd @@ -7,9 +7,10 @@ gsw_sigma0(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ potential density anomaly [ kg/m^3 ] @@ -23,8 +24,8 @@ minus 1000 kg/m^3. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,27 +56,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_sigma1.Rd b/man/gsw_sigma1.Rd index df5a11ef..67e53a8a 100644 --- a/man/gsw_sigma1.Rd +++ b/man/gsw_sigma1.Rd @@ -7,9 +7,10 @@ gsw_sigma1(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ potential density anomaly [ kg/m^3 ] @@ -23,8 +24,8 @@ minus 1000 kg/m^3. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,27 +56,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_sigma2.Rd b/man/gsw_sigma2.Rd index 496bdf07..92c3760d 100644 --- a/man/gsw_sigma2.Rd +++ b/man/gsw_sigma2.Rd @@ -7,9 +7,10 @@ gsw_sigma2(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ potential density anomaly [ kg/m^3 ] @@ -23,8 +24,8 @@ minus 1000 kg/m^3. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,27 +56,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_sigma3.Rd b/man/gsw_sigma3.Rd index de3bdc42..c3066dae 100644 --- a/man/gsw_sigma3.Rd +++ b/man/gsw_sigma3.Rd @@ -7,9 +7,10 @@ gsw_sigma3(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ potential density anomaly with reference pressure 3000 dbar [ kg/m^3 ] @@ -23,8 +24,8 @@ minus 1000 kg/m^3. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,27 +56,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_sigma4.Rd b/man/gsw_sigma4.Rd index bd3863e7..1debc8f0 100644 --- a/man/gsw_sigma4.Rd +++ b/man/gsw_sigma4.Rd @@ -7,9 +7,10 @@ gsw_sigma4(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ potential density anomaly with reference pressure 4000 dbar [ kg/m^3 ] @@ -23,8 +24,8 @@ minus 1000 kg/m^3. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -55,27 +56,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_sound_speed.Rd b/man/gsw_sound_speed.Rd index c2076864..a2465849 100644 --- a/man/gsw_sound_speed.Rd +++ b/man/gsw_sound_speed.Rd @@ -7,9 +7,10 @@ gsw_sound_speed(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Speed of sound in seawater, using the 75-term equation for specific volume. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_sound_speed_ice.Rd b/man/gsw_sound_speed_ice.Rd index 8a132b50..4919c272 100644 --- a/man/gsw_sound_speed_ice.Rd +++ b/man/gsw_sound_speed_ice.Rd @@ -21,8 +21,8 @@ Speed of sound in ice. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -50,7 +50,7 @@ stopifnot(all.equal(speed/1e3, c(3.111311360346254, 3.116492565497544, 3.1158334 } \seealso{ Other things related to sound: -\code{\link{gsw_sound_speed_t_exact}()}, -\code{\link{gsw_sound_speed}()} +\code{\link{gsw_sound_speed}()}, +\code{\link{gsw_sound_speed_t_exact}()} } \concept{things related to sound} diff --git a/man/gsw_sound_speed_t_exact.Rd b/man/gsw_sound_speed_t_exact.Rd index ebb5780e..bba7026e 100644 --- a/man/gsw_sound_speed_t_exact.Rd +++ b/man/gsw_sound_speed_t_exact.Rd @@ -7,7 +7,8 @@ gsw_sound_speed_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Sound Speed in Seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -53,7 +54,7 @@ stopifnot(all.equal(sound_speed/1e3, c(1.542615803587414, 1.542703534065789, 1.5 } \seealso{ Other things related to sound: -\code{\link{gsw_sound_speed_ice}()}, -\code{\link{gsw_sound_speed}()} +\code{\link{gsw_sound_speed}()}, +\code{\link{gsw_sound_speed_ice}()} } \concept{things related to sound} diff --git a/man/gsw_specvol.Rd b/man/gsw_specvol.Rd index 30b1c5d2..977f2301 100644 --- a/man/gsw_specvol.Rd +++ b/man/gsw_specvol.Rd @@ -7,9 +7,10 @@ gsw_specvol(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Specific Volume of Seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -57,19 +58,20 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, diff --git a/man/gsw_specvol_alpha_beta.Rd b/man/gsw_specvol_alpha_beta.Rd index 4c37e151..7d76b3b1 100644 --- a/man/gsw_specvol_alpha_beta.Rd +++ b/man/gsw_specvol_alpha_beta.Rd @@ -7,9 +7,10 @@ gsw_specvol_alpha_beta(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -25,8 +26,8 @@ Specific Volume, alpha, and beta This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -62,27 +63,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_anom_standard}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_specvol_anom_standard.Rd b/man/gsw_specvol_anom_standard.Rd index 8f4ca4ee..92fad418 100644 --- a/man/gsw_specvol_anom_standard.Rd +++ b/man/gsw_specvol_anom_standard.Rd @@ -7,9 +7,10 @@ gsw_specvol_anom_standard(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -24,8 +25,8 @@ provided in the C library, so it is not provided in R, either. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -57,27 +58,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_specvol_first_derivatives.Rd b/man/gsw_specvol_first_derivatives.Rd index 88566d7f..35475c60 100644 --- a/man/gsw_specvol_first_derivatives.Rd +++ b/man/gsw_specvol_first_derivatives.Rd @@ -7,9 +7,10 @@ gsw_specvol_first_derivatives(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -28,8 +29,8 @@ First Derivatives of Specific Volume This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -67,21 +68,21 @@ stopifnot(all.equal(r$v_p/1e-12, Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, \code{\link{gsw_specvol_first_derivatives_wrt_enthalpy}()} } \concept{things related to enthalpy} diff --git a/man/gsw_specvol_first_derivatives_wrt_enthalpy.Rd b/man/gsw_specvol_first_derivatives_wrt_enthalpy.Rd index ed7a2fa6..aca82b52 100644 --- a/man/gsw_specvol_first_derivatives_wrt_enthalpy.Rd +++ b/man/gsw_specvol_first_derivatives_wrt_enthalpy.Rd @@ -7,9 +7,10 @@ gsw_specvol_first_derivatives_wrt_enthalpy(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ First Derivatives of Specific Volume wrt Enthalpy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -59,21 +60,21 @@ stopifnot(all.equal(r$v_h/1e-10, Other things related to enthalpy: \code{\link{gsw_CT_from_enthalpy}()}, \code{\link{gsw_dynamic_enthalpy}()}, +\code{\link{gsw_enthalpy}()}, \code{\link{gsw_enthalpy_CT_exact}()}, \code{\link{gsw_enthalpy_diff}()}, -\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_first_derivatives}()}, +\code{\link{gsw_enthalpy_first_derivatives_CT_exact}()}, \code{\link{gsw_enthalpy_ice}()}, \code{\link{gsw_enthalpy_t_exact}()}, -\code{\link{gsw_enthalpy}()}, -\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_frazil_properties_potential}()}, -\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, +\code{\link{gsw_frazil_properties_potential_poly}()}, \code{\link{gsw_pot_enthalpy_from_pt_ice}()}, -\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, +\code{\link{gsw_pot_enthalpy_from_pt_ice_poly}()}, \code{\link{gsw_pot_enthalpy_ice_freezing}()}, -\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, +\code{\link{gsw_pot_enthalpy_ice_freezing_poly}()}, \code{\link{gsw_pt_from_pot_enthalpy_ice}()}, +\code{\link{gsw_pt_from_pot_enthalpy_ice_poly}()}, \code{\link{gsw_specvol_first_derivatives}()} } \concept{things related to enthalpy} diff --git a/man/gsw_specvol_ice.Rd b/man/gsw_specvol_ice.Rd index a0ddc38a..1303571a 100644 --- a/man/gsw_specvol_ice.Rd +++ b/man/gsw_specvol_ice.Rd @@ -21,8 +21,8 @@ Specific Volume of Ice This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -53,27 +53,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, -\code{\link{gsw_specvol_t_exact}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_t_exact}()} } \concept{things related to density} diff --git a/man/gsw_specvol_second_derivatives.Rd b/man/gsw_specvol_second_derivatives.Rd index 1d9e0096..f420d857 100644 --- a/man/gsw_specvol_second_derivatives.Rd +++ b/man/gsw_specvol_second_derivatives.Rd @@ -7,9 +7,10 @@ gsw_specvol_second_derivatives(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -31,8 +32,8 @@ Second Derivatives of Specific Volume This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_specvol_second_derivatives_wrt_enthalpy.Rd b/man/gsw_specvol_second_derivatives_wrt_enthalpy.Rd index 49be5179..b9063019 100644 --- a/man/gsw_specvol_second_derivatives_wrt_enthalpy.Rd +++ b/man/gsw_specvol_second_derivatives_wrt_enthalpy.Rd @@ -7,9 +7,10 @@ gsw_specvol_second_derivatives_wrt_enthalpy(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -28,8 +29,8 @@ Second Derivatives of Specific Volume wrt Enthalpy This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_specvol_t_exact.Rd b/man/gsw_specvol_t_exact.Rd index a9ce825a..1bad5dca 100644 --- a/man/gsw_specvol_t_exact.Rd +++ b/man/gsw_specvol_t_exact.Rd @@ -7,7 +7,8 @@ gsw_specvol_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Specific Volume of Seawater This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. @@ -56,27 +57,28 @@ Other things related to density: \code{\link{gsw_CT_from_rho}()}, \code{\link{gsw_CT_maxdensity}()}, \code{\link{gsw_SA_from_rho}()}, +\code{\link{gsw_alpha}()}, \code{\link{gsw_alpha_on_beta}()}, \code{\link{gsw_alpha_wrt_t_exact}()}, \code{\link{gsw_alpha_wrt_t_ice}()}, -\code{\link{gsw_alpha}()}, -\code{\link{gsw_beta_const_t_exact}()}, \code{\link{gsw_beta}()}, +\code{\link{gsw_beta_const_t_exact}()}, +\code{\link{gsw_infunnel}()}, \code{\link{gsw_pot_rho_t_exact}()}, +\code{\link{gsw_rho}()}, \code{\link{gsw_rho_alpha_beta}()}, -\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_first_derivatives}()}, +\code{\link{gsw_rho_first_derivatives_wrt_enthalpy}()}, \code{\link{gsw_rho_ice}()}, \code{\link{gsw_rho_t_exact}()}, -\code{\link{gsw_rho}()}, \code{\link{gsw_sigma0}()}, \code{\link{gsw_sigma1}()}, \code{\link{gsw_sigma2}()}, \code{\link{gsw_sigma3}()}, \code{\link{gsw_sigma4}()}, +\code{\link{gsw_specvol}()}, \code{\link{gsw_specvol_alpha_beta}()}, \code{\link{gsw_specvol_anom_standard}()}, -\code{\link{gsw_specvol_ice}()}, -\code{\link{gsw_specvol}()} +\code{\link{gsw_specvol_ice}()} } \concept{things related to density} diff --git a/man/gsw_spiciness0.Rd b/man/gsw_spiciness0.Rd index 7cbd6839..2df12b69 100644 --- a/man/gsw_spiciness0.Rd +++ b/man/gsw_spiciness0.Rd @@ -7,9 +7,10 @@ gsw_spiciness0(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ spiciness [ kg/m^3 ] @@ -21,8 +22,8 @@ Calculate seawater spiciness referenced to 0 dbar (i.e. the surface). This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_spiciness1.Rd b/man/gsw_spiciness1.Rd index ef8ed02a..f822c468 100644 --- a/man/gsw_spiciness1.Rd +++ b/man/gsw_spiciness1.Rd @@ -7,9 +7,10 @@ gsw_spiciness1(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ spiciness [ kg/m^3 ] @@ -21,8 +22,8 @@ Calculate seawater spiciness referenced to 1000 dbar. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_spiciness2.Rd b/man/gsw_spiciness2.Rd index a471abe1..3697f8b3 100644 --- a/man/gsw_spiciness2.Rd +++ b/man/gsw_spiciness2.Rd @@ -7,9 +7,10 @@ gsw_spiciness2(SA, CT) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} } \value{ spiciness [ kg/m^3 ] @@ -21,8 +22,8 @@ Calculate seawater spiciness referenced to 2000 dbar. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_t_deriv_chem_potential_water_t_exact.Rd b/man/gsw_t_deriv_chem_potential_water_t_exact.Rd index ac5768ca..f46fe8eb 100644 --- a/man/gsw_t_deriv_chem_potential_water_t_exact.Rd +++ b/man/gsw_t_deriv_chem_potential_water_t_exact.Rd @@ -7,7 +7,8 @@ gsw_t_deriv_chem_potential_water_t_exact(SA, t, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{t}{in-situ temperature (ITS-90) [ degC ]} @@ -23,8 +24,8 @@ Derivative of Chemical Potential of Water in Seawater wrt Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_t_freezing.Rd b/man/gsw_t_freezing.Rd index 546c2159..099410a5 100644 --- a/man/gsw_t_freezing.Rd +++ b/man/gsw_t_freezing.Rd @@ -7,7 +7,8 @@ gsw_t_freezing(SA, p, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -26,8 +27,8 @@ for those test values). This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_t_freezing_first_derivatives.Rd b/man/gsw_t_freezing_first_derivatives.Rd index 68568f04..fdb766a3 100644 --- a/man/gsw_t_freezing_first_derivatives.Rd +++ b/man/gsw_t_freezing_first_derivatives.Rd @@ -7,7 +7,8 @@ gsw_t_freezing_first_derivatives(SA, p, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -25,8 +26,8 @@ Derivatives of Freezing Water Properties This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_t_freezing_first_derivatives_poly.Rd b/man/gsw_t_freezing_first_derivatives_poly.Rd index 4f385d96..75e93704 100644 --- a/man/gsw_t_freezing_first_derivatives_poly.Rd +++ b/man/gsw_t_freezing_first_derivatives_poly.Rd @@ -7,7 +7,8 @@ gsw_t_freezing_first_derivatives_poly(SA, p, saturation_fraction = 1) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} @@ -25,8 +26,8 @@ Derivatives of Freezing Water Properties (Polynomial version) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_t_from_CT.Rd b/man/gsw_t_from_CT.Rd index 25c4223f..0beee2b7 100644 --- a/man/gsw_t_from_CT.Rd +++ b/man/gsw_t_from_CT.Rd @@ -7,9 +7,10 @@ gsw_t_from_CT(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ In situ temperature from Conservative Temperature This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_t_from_pt0_ice.Rd b/man/gsw_t_from_pt0_ice.Rd index e1d57786..e8de63b4 100644 --- a/man/gsw_t_from_pt0_ice.Rd +++ b/man/gsw_t_from_pt0_ice.Rd @@ -21,8 +21,8 @@ In situ Temperature from Potential Temperature at 0dbar This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_thermobaric.Rd b/man/gsw_thermobaric.Rd index d0853131..2ac1af4d 100644 --- a/man/gsw_thermobaric.Rd +++ b/man/gsw_thermobaric.Rd @@ -7,9 +7,10 @@ gsw_thermobaric(SA, CT, p) } \arguments{ -\item{SA}{Absolute Salinity [ g/kg ]} +\item{SA}{Absolute Salinity [ g/kg ]. The valid range for most `gsw` +functions is 0 to 42 g/kg.} -\item{CT}{Conservative Temperature [ degC ]} +\item{CT}{Conservative Temperature [ degC ].} \item{p}{sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar} } @@ -23,8 +24,8 @@ Thermobaric coefficient (75-term equation) This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/man/gsw_z_from_p.Rd b/man/gsw_z_from_p.Rd index db8e0a41..fcd78359 100644 --- a/man/gsw_z_from_p.Rd +++ b/man/gsw_z_from_p.Rd @@ -33,8 +33,8 @@ specific volume. This R function uses a wrapper to a C function contained within the GSW-C -system as updated 2021-12-28 at \url{https://github.com/TEOS-10/GSW-C} with -git commit `98f0fd40dd9ceb0ba82c9d47ac750e935a7d0459`. +system as updated 2022-10-11 at \url{https://github.com/TEOS-10/GSW-C} with +git commit `657216dd4f5ea079b5f0e021a4163e2d26893371`. The C function uses data from the \code{library/gsw_data_v3_0.mat} file provided in the GSW-Matlab source code, version 3.06-11. diff --git a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/t_equilib.dat b/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/t_equilib.dat deleted file mode 100644 index e07886a5..00000000 --- a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/t_equilib.dat +++ /dev/null @@ -1,51 +0,0 @@ -% Equilibrium Tidal Potential -% -% Values taken from Appendix 1 of Godin, "The Analysis -% of Tides", Univ. Toronto Press, 1972. -% -% Constants multiplied by 1e5. -% Names as in tide3.dat -% -%Name Species A B -SA 0 1160 0 -SSA 0 7299 0 -MM 0 8254 0 -MSF 0 1376 0 -MF 0 15642 0 -ALP1 1 0 278 -2Q1 1 0 955 -SIG1 1 0 1153 -Q1 1 0 7216 -RHO1 1 0 1371 -O1 1 0 37689 -TAU1 1 0 -491 -BET1 1 0 -278 -NO1 1 0 -2964 -CHI1 1 0 -566 -PI1 1 0 1029 -P1 1 0 17584 -S1 1 0 -423 -K1 1 0-53050 -PSI1 1 0 -423 -THE1 1 0 -756 -J1 1 0 -2964 -OO1 1 0 -1623 -UPS1 1 0 -311 -OQ2 2 259 0 -EPS2 2 671 0 -2N2 2 2301 0 -MU2 2 2777 0 -N2 2 17387 0 -NU2 2 3303 0 -GAM2 2 -273 0 -H1 2 -314 0 -M2 2 90812 0 -H2 2 276 0 -LDA2 2 -670 0 -L2 2 -2567 0 -T2 2 2479 0 -S2 2 42358 0 -R2 2 -354 0 -K2 2 11506 0 -ETA2 2 643 0 -M3 3 -1188 0 diff --git a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_ad2cp_3.R b/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_ad2cp_3.R deleted file mode 100644 index 1572cda8..00000000 --- a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_ad2cp_3.R +++ /dev/null @@ -1,164 +0,0 @@ -# vim:textwidth=80:expandtab:shiftwidth=4:softtabstop=4 -# -# Test a Nortek Signature100 dataset in AD2CP format that was kindly provided by -# @richardsc. It contains burstAltimeterRaw data (unlike the dataset used by -# test_ad2cp_1.R and test_ad2cp_2.R). -# -# The tests measure consistency over time, as a guard against code changes (e.g. -# the conversion in June and July of 2022 to vectorized reading) and UI changes -# (e.g. renaming of variables). - -library(oce) - -file <- "local_data/ad2cp/S102791A002_Barrow_v2.ad2cp" -if (file.exists(file)) { - test_that("S102791A002_Barrow_v2.ad2cp 'distance' works", - { - expect_warning( - expect_warning( - d <- read.oce(file), - "using to=1477 based on file contents"), - "'plan' defaulting to 0") - expect_equal( - head(d@data$burstAltimeterRaw$altimeterRaw$distance), - c(40.024, 40.048, 40.072, 40.096, 40.12, 40.144)) - expect_equal( - tail(d@data$burstAltimeterRaw$altimeterRaw$distance), - c(83.872, 83.896, 83.92, 83.944, 83.968, 83.992)) - expect_equal( - length(d@data$burstAltimeterRaw$altimeterRaw$distance), - 1833L) - }) - test_that("various tests for S102791A002_Barrow_v2.ad2cp (signature 250)", - { - expect_warning( - expect_warning( - d <- read.oce(file), - "using to=1477 based on file contents"), - "'plan' defaulting to 0") - # Identifiers - expect_equal(d[["type"]], "Signature250") - expect_equal(d[["fileType"]], "AD2CP") - expect_equal(d[["serialNumber"]], 102791) - # Entry names - expect_equal(sort(names(d[["data"]])), - c("average", "bottomTrack", "burst", "burstAltimeterRaw")) - - expect_equal(sort(names(d[["average"]])), - c("a", "accelerometer", "blankingDistance", "cellSize", - "configuration", "datasetDescription", "distance", - "ensemble", "heading", "magnetometer", "nominalCorrelation", - "numberOfBeams", "numberOfCells", "oceCoordinate", - "orientation", "originalCoordinate", "pitch", "powerLevel", - "pressure", "q", "roll", "soundSpeed", "temperature", - "temperatureMagnetometer", "temperatureRTC", "time", - "transmitEnergy", "v")) - - # Beams and cells - expect_equal(d[["average"]]$oceCoordinate, "beam") - # data$average - a <- d[["average"]] - expect_equal(a$cellSize, 1) - expect_equal(a$blankingDistance, 0.5) - expect_equal(a$numberOfBeams, 4) - expect_equal(a$numberOfCells, 87) - expect_equal(a$blankingDistance, 0.5) - expect_equal(dim(a$v), c(360, 87, 4)) - expect_equal(dim(a$a), c(360, 87, 4)) - expect_equal(dim(a$q), c(360, 87, 4)) - expect_equal(a$v[1:3,1:3,1:3], - structure(c(-0.553, -0.542, -0.545, 2.255, -0.448, 1.695, 2.003, - 0.612, 2.415, 0.647, 0.641, 0.649, 1.701, 1.449, 1.762, - 0.861, 0.971, 1.773, 0.099, 0.065, 0.096, -0.239, -0.235, - -0.217, -0.37, -0.365, -0.393), dim=c(3L, 3L, 3L))) - expect_equal(a$a[1:3,1:3,1:3], - structure(as.raw(c(0x6e, 0x6e, 0x6e, 0x34, 0x35, 0x34, 0x24, 0x22, - 0x24, 0x70, 0x70, 0x70, 0x37, 0x37, 0x36, 0x23, 0x22, - 0x21, 0x67, 0x67, 0x67, 0x6c, 0x6c, 0x6c, 0x4b, 0x4b, - 0x4b)), dim=c(3L, 3L, 3L))) - expect_equal(a$q[1:3,1:3,1:3], - structure(as.raw(c(0x20, 0x21, 0x21, 0x15, 0x0d, 0x19, 0x1d, 0x15, - 0x18, 0x3a, 0x3a, 0x3a, 0x11, 0x15, 0x08, 0x19, 0x1e, - 0x16, 0x55, 0x54, 0x55, 0x58, 0x59, 0x59, 0x4b, 0x4c, - 0x4d)), dim=c(3L, 3L, 3L))) - expect_equal(head(a$time), - structure(c(1653479685.6677, 1653479687.6677, 1653479689.6677, - 1653479691.6677, 1653479693.6677, 1653479695.6677), - class=c("POSIXct", "POSIXt"), tzone="UTC")) - - # bottomTrack -- FIXME - bt <- d[["bottomTrack"]] # FIXME: the values are crazy, e.g. lots of v of order e-15 - - # burst -- FIXME - b <- d[["burst"]] - - # FIXME: values are crazy, e.g. just 1 ASTDistance and ASTPressure, - # and what else is supposed to be there? - - # FIXME: these tests talk of burstAltimeterRaw but I don't think - # this exists in this file. - - #??? # burstAltimeterRaw - #??? bar <- d[["burst"]] - #??? expect_equal("beam", bar$originalCoordinate) - #??? expect_equal("beam", bar$oceCoordinate) - #??? # FIXME: ensemble not checked (and it's always 1, which *must* be wrong) - #??? expect_equal(head(bar$magnetometer$x), - #??? c(356L, 354L, 355L, 355L, 354L, 355L)) - #??? expect_equal(head(bar$magnetometer$y), - #??? c(-310L, -310L, -310L, -311L, -309L, -310L)) - #??? expect_equal(head(bar$magnetometer$z), - #??? c(171L, 171L, 170L, 170L, 169L, 170L)) - #??? expect_equal(head(bar$accelerometer$x), - #??? c(-0.71142578125, -0.71142578125, -0.7119140625, -0.711669921875, - #??? -0.71142578125, -0.711669921875)) - #??? expect_equal(head(bar$accelerometer$y), - #??? c(0.70111083984375, 0.70086669921875, 0.70086669921875, - #??? 0.70086669921875, 0.70111083984375, 0.70062255859375)) - #??? expect_equal(head(bar$accelerometer$z), - #??? c(0.01654052734375, 0.01654052734375, 0.01654052734375, - #??? 0.01654052734375, 0.01654052734375, 0.01678466796875)) - #??? expect_equal(1833L, bar$altimeterRawNumberOfSamples) - #??? expect_equal(bar$altimeterRawSamples[1:3,1:3], - #??? structure(c(2313L, 1542L, 2560L, 2560L, 2442L, 3150L, 2313L, 4570L, - #??? 3579L), dim = c(3L, 3L))) - #??? expect_equal(head(bar$altimeterDistance), - #??? c(42.0308685302734, 42.1037330627441, 42.1036491394043, 40.7197113037109, - #??? 42.1040687561035, 40.7203636169434)) - #??? expect_equal(head(bar$pressure), - #??? c(0.807, 0.801, 0.8, 0.792, 0.808, 0.796)) - #??? expect_true(all("zup" == bar[["orientation"]])) - #??? expect_equal(head(bar$ASTDistance), - #??? c(42.1686553955078, 42.2458877563477, 42.2420387268066, - #??? 40.852237701416, 42.2431640625, 40.8575706481934)) - #??? expect_equal(head(bar$ASTPressure), - #??? c(0.806999981403351, 0.800999999046326, 0.800000011920929, - #??? 0.791999995708466, 0.808000028133392, 0.796000003814697)) - - #??? # Time - #??? expect_equal(head(d[["time"]]), - #??? structure(c(1653479685.6677, 1653479687.6677, 1653479689.6677, - #??? 1653479691.6677, 1653479693.6677, 1653479695.6677), class = - #??? c("POSIXct", "POSIXt"), tzone = "UTC")) - #??? expect_equal(d[["time"]], d[["time", "average"]]) - - #??? # Pressure, temperature etc - #??? expect_equal(head(d[["pressure"]]), - #??? c(0.791, 0.801, 0.807, 0.796, 0.803, 0.799)) - #??? expect_equal(d[["pressure", "average"]], d[["pressure"]]) - #??? expect_equal(head(d[["temperature"]]), - #??? c(20.18, 20.18, 20.18, 20.18, 20.18, 20.18)) - #??? expect_equal(d[["temperature"]], d[["temperature", "average"]]) - #??? expect_equal(head(d[["heading"]]), - #??? c(280.21, 279.75, 279.97, 279.75, 279.72, 279.82)) - #??? expect_equal(d[["heading"]], d[["heading", "average"]]) - #??? expect_equal(head(d[["pitch"]]), - #??? c(-45.4, -45.43, -45.43, -45.41, -45.42, -45.42)) - #??? expect_equal(d[["pitch"]], d[["pitch", "average"]]) - - #??? expect_equal(head(d[["roll"]]), - #??? c(88.64, 88.62, 88.62, 88.64, 88.64, 88.62)) - #??? expect_equal(d[["roll"]], d[["roll", "average"]]) - }) -} - diff --git a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_ctd_aml.R b/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_ctd_aml.R deleted file mode 100644 index 65f7ac85..00000000 --- a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_ctd_aml.R +++ /dev/null @@ -1,19 +0,0 @@ -# vim:textwidth=80:expandtab:shiftwidth=4:softtabstop=4 -library(oce) -file <- system.file("extdata", "ctd_aml.csv", package="oce") - -# https://github.com/dankelley/oce/issues/1891 -test_that("read.ctd.aml() works (issue 1924)", { - ctd <- read.ctd.aml(file) - expect_equal(ctd[["longitude"]], -145.8477) - expect_equal(ctd[["latitude"]], 70.2284 ) - expect_true(is.na(ctd[["serialNumber"]])) - expect_equal(length(ctd[["header"]]), 109L) - expect_equal(head(ctd[["pressure"]],3), - c(0.23, 0.22, 0.22)) - expect_equal(head(ctd[["salinity"]],3), - c(5.57787090635139, 9.97826094600314, 14.628766628731)) - expect_equal(head(ctd[["temperature"]],3), - c(5.671, 5.509, 5.4)) -}) - diff --git a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_ctd_ssda.R b/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_ctd_ssda.R deleted file mode 100644 index 880528f3..00000000 --- a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_ctd_ssda.R +++ /dev/null @@ -1,30 +0,0 @@ -# vim:textwidth=80:expandtab:shiftwidth=4:softtabstop=4 - -# Test Sun & Sea CTD data file. -# https://github.com/dankelley/oce/discussions/1929 -# -# NOTE 2022-08-16: I moved this to a non-CRAN test because it fails on the CRAN -# test machine labelled as r-devel-linux-x86_64-debian-clang. Debugging for -# that machine is not easy, given that rhub hasn't offered a supposedly -# analagous machine for weeks. I moved the test to be local, so at least -# developers can check it, without risking CRAN rejection for a problem. - -library(oce) -file <- "local_data/ctd_ssda.csv" -if (file.exists(file)) { - skip_on_cran() - test_that("read.ctd.ssda() works (discussions/1929)", - { - ctd <- read.oce(file) - expect_equal(ctd[["longitude"]], 15.9990216666667) - expect_equal(ctd[["latitude"]], 55.292085) - expect_equal(length(ctd[["header"]]), 47L) - expect_equal(ctd[["salinity"]], - c(0.08, 0.11, 0.12, 0.12, 0.11, 0.11)) - expect_equal(ctd[["temperature"]], - c(5.007, 4.999, 4.993, 4.988, 4.984, 4.981)) - expect_equal(ctd[["pressure"]], - c(0, -0.01, -0.02, -0.01, -0.02, -0.02)) - }) -} - diff --git a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_hydrographic.R b/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_hydrographic.R deleted file mode 100644 index 0055c62f..00000000 --- a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_hydrographic.R +++ /dev/null @@ -1,86 +0,0 @@ -# vim:textwidth=80:expandtab:shiftwidth=4:softtabstop=4 - -# Test whether base-level [[ can handle hydrographic computations - -library(oce) -data(ctd) - -S <- ctd[["salinity"]] -T <- ctd[["temperature"]] -p <- ctd[["pressure"]] -lon <- ctd[["longitude"]] -lat <- ctd[["latitude"]] -nlevel <- length(S) - -# Object with no location data (for UNESCO testing) -nu <- new("oce") -nu <- oceSetData(nu, "salinity", S) -nu <- oceSetData(nu, "temperature", T) -nu <- oceSetData(nu, "pressure", p) - -# Object with location data (for GSW testing) -ng <- new("oce") -ng <- oceSetData(ng, "salinity", S) -ng <- oceSetData(ng, "temperature", T) -ng <- oceSetData(ng, "pressure", p) -ng <- oceSetMetadata(ng, "longitude", lon) -ng <- oceSetMetadata(ng, "latitude", lat) - -# The two theta values differ by max 4.819825e-6 degC -thetaUNESCO <- swTheta(S, T, p, eos="unesco") -thetaGSW <- swTheta(S, T, p, longitude=lon, latitude=lat, eos="gsw") - -test_that("base-level [[\"?\"]] gives expected names (UNESCO)", { - # using sort() because the order (for some reason I do not understand) is - # different when I do it interactively, versus in the test as set up by - # RStudio. I guess RStudio is using a different default for sorting - # character values. - expect_equal(sort(nu[["?"]]$dataDerived), sort(c("density", "depth", "N2", - paste("potential", "temperature"), "Rrho", "RrhoSF", - "sigmaTheta", paste("sound", "speed"), "SP", "spice", "theta", - "z"))) -}) - -test_that("base-level [[\"?\"]] works on some hydrographic things (UNESCO)", { - options(oceEOS="unesco") - expect_equal(ctd[["theta"]], nu[["theta"]]) - expect_error(nu[["CT"]], "need longitude and latitude to compute") - expect_error(nu[["SA"]], "need longitude and latitude to compute") - expect_error(nu[["Sstar"]], "need longitude and latitude to compute") -}) - - -test_that("base-level [[\"?\"]] gives expected names (GSW)", { - expect_equal(sort(ng[["?"]]$dataDerived), - sort(c(paste("Absolute", "Salinity"), - paste("Conservative", "Temperature"), - "CT", - "density", "depth", "N2", paste("potential", "temperature"), - "Rrho", "RrhoSF", "SA", - paste0("sigma", 0:4), - paste0("spiciness", 0:2), - "sigmaTheta", paste("sound", "speed"), "SP", "spice", - "SR", "Sstar", "theta", "z"))) -}) - -test_that("base-level [[\"?\"]] works on some hydrographic things (GSW)", { - options(oceEOS="gsw") - expect_equal(ctd[["theta"]], ng[["theta"]]) - expect_equal(ctd[["CT"]], ng[["CT"]]) - expect_equal(ctd[["SA"]], ng[["SA"]]) - expect_equal(ctd[["Sstar"]], ng[["Sstar"]]) -}) - -test_that("base-level [[\"?\"]] all names work (UNESCO)", { - options(oceEOS="unesco") - a <- nu[["?"]]$dataDerived - expect_true(all(nlevel == sapply(a, function(i) sum(is.finite(nu[[i]]))))) -}) - -test_that("base-level [[\"?\"]] all names work (GSW)", { - options(oceEOS="gsw") - a <- ng[["?"]]$dataDerived - expect_true(all(nlevel == sapply(a, function(i) sum(is.finite(ng[[i]]))))) -}) - - diff --git a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_missing_file.R b/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_missing_file.R deleted file mode 100644 index 4e691cfd..00000000 --- a/revdep/checks.noindex/oce/new/oce.Rcheck/tests/testthat/test_missing_file.R +++ /dev/null @@ -1,55 +0,0 @@ -library(oce) -test_that("all read() functions give similar errors for missing files", - { - msg <- "cannot find file 'no such file'" - expect_error(read.adp("no such file"), msg) - expect_error(read.adp.ad2cp("no such file"), msg) - expect_error(read.adp.rdi("no such file"), msg) - expect_error(read.adp.nortek("no such file"), msg) - expect_error(read.adp.sontek("no such file"), msg) - expect_error(read.adp.sontek.serial("no such file"), msg) - expect_error(read.adv("no such file"), msg) - expect_error(read.adv.nortek("no such file"), msg) - expect_error(read.adv.sontek.serial("no such file"), msg) - expect_error(read.adv.sontek.adr("no such file"), msg) - expect_error(read.adv.sontek.text("no such file"), msg) - expect_error(read.amsr("no such file"), msg) - expect_error(read.aquadopp("no such file"), msg) - expect_error(read.aquadoppProfiler("no such file"), msg) - expect_error(read.aquadoppHR("no such file"), msg) - expect_error(read.argo("no such file"), msg) - expect_error(read.argo.copernicus("no such file"), msg) - expect_error(read.bremen("no such file"), msg) - expect_error(read.cm("no such file"), msg) - expect_error(read.coastline("no such file"), msg) - expect_error(read.coastline.shapefile("no such file"), msg) - expect_error(read.coastline.openstreetmap("no such file"), msg) - expect_error(read.ctd("no such file"), msg) - expect_error(read.ctd.aml("no such file"), msg) - expect_error(read.ctd.sbe("no such file"), msg) - expect_error(read.ctd.ssda("no such file"), msg) - expect_error(read.ctd.woce("no such file"), msg) - expect_error(read.ctd.woce.other("no such file"), msg) - expect_error(read.ctd.odf("no such file"), msg) - expect_error(read.ctd.odv("no such file"), msg) - expect_error(read.ctd.itp("no such file"), msg) - expect_error(read.echosounder("no such file"), msg) - expect_error(read.g1sst("no such file"), msg) - expect_error(read.gps("no such file"), msg) - expect_error(read.index("no such file"), msg) - expect_error(read.landsat("no such file"), msg) - expect_error(read.lisst("no such file"), msg) - expect_error(read.lobo("no such file"), msg) - expect_error(read.met("no such file"), msg) - expect_error(read.topo("no such file"), msg) - expect_error(read.netcdf("no such file"), msg) - expect_error(read.oce("no such file"), msg) - expect_error(read.odf("no such file"), msg) - expect_error(read.rsk("no such file"), msg) - expect_error(read.sealevel("no such file"), msg) - expect_error(read.section("no such file"), msg) - expect_error(read.woa("no such file"), msg) - expect_error(read.xbt("no such file"), msg) - expect_error(read.xbt.edf("no such file"), msg) - expect_error(read.xbt.noaa1("no such file"), msg) - }) diff --git a/revdep/checks.noindex/oce/oce_1.7-10.tar.gz b/revdep/checks.noindex/oce/oce_1.7-10.tar.gz deleted file mode 100644 index 470729c1..00000000 Binary files a/revdep/checks.noindex/oce/oce_1.7-10.tar.gz and /dev/null differ diff --git a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/t_equilib.dat b/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/t_equilib.dat deleted file mode 100644 index e07886a5..00000000 --- a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/t_equilib.dat +++ /dev/null @@ -1,51 +0,0 @@ -% Equilibrium Tidal Potential -% -% Values taken from Appendix 1 of Godin, "The Analysis -% of Tides", Univ. Toronto Press, 1972. -% -% Constants multiplied by 1e5. -% Names as in tide3.dat -% -%Name Species A B -SA 0 1160 0 -SSA 0 7299 0 -MM 0 8254 0 -MSF 0 1376 0 -MF 0 15642 0 -ALP1 1 0 278 -2Q1 1 0 955 -SIG1 1 0 1153 -Q1 1 0 7216 -RHO1 1 0 1371 -O1 1 0 37689 -TAU1 1 0 -491 -BET1 1 0 -278 -NO1 1 0 -2964 -CHI1 1 0 -566 -PI1 1 0 1029 -P1 1 0 17584 -S1 1 0 -423 -K1 1 0-53050 -PSI1 1 0 -423 -THE1 1 0 -756 -J1 1 0 -2964 -OO1 1 0 -1623 -UPS1 1 0 -311 -OQ2 2 259 0 -EPS2 2 671 0 -2N2 2 2301 0 -MU2 2 2777 0 -N2 2 17387 0 -NU2 2 3303 0 -GAM2 2 -273 0 -H1 2 -314 0 -M2 2 90812 0 -H2 2 276 0 -LDA2 2 -670 0 -L2 2 -2567 0 -T2 2 2479 0 -S2 2 42358 0 -R2 2 -354 0 -K2 2 11506 0 -ETA2 2 643 0 -M3 3 -1188 0 diff --git a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_ad2cp_3.R b/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_ad2cp_3.R deleted file mode 100644 index 1572cda8..00000000 --- a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_ad2cp_3.R +++ /dev/null @@ -1,164 +0,0 @@ -# vim:textwidth=80:expandtab:shiftwidth=4:softtabstop=4 -# -# Test a Nortek Signature100 dataset in AD2CP format that was kindly provided by -# @richardsc. It contains burstAltimeterRaw data (unlike the dataset used by -# test_ad2cp_1.R and test_ad2cp_2.R). -# -# The tests measure consistency over time, as a guard against code changes (e.g. -# the conversion in June and July of 2022 to vectorized reading) and UI changes -# (e.g. renaming of variables). - -library(oce) - -file <- "local_data/ad2cp/S102791A002_Barrow_v2.ad2cp" -if (file.exists(file)) { - test_that("S102791A002_Barrow_v2.ad2cp 'distance' works", - { - expect_warning( - expect_warning( - d <- read.oce(file), - "using to=1477 based on file contents"), - "'plan' defaulting to 0") - expect_equal( - head(d@data$burstAltimeterRaw$altimeterRaw$distance), - c(40.024, 40.048, 40.072, 40.096, 40.12, 40.144)) - expect_equal( - tail(d@data$burstAltimeterRaw$altimeterRaw$distance), - c(83.872, 83.896, 83.92, 83.944, 83.968, 83.992)) - expect_equal( - length(d@data$burstAltimeterRaw$altimeterRaw$distance), - 1833L) - }) - test_that("various tests for S102791A002_Barrow_v2.ad2cp (signature 250)", - { - expect_warning( - expect_warning( - d <- read.oce(file), - "using to=1477 based on file contents"), - "'plan' defaulting to 0") - # Identifiers - expect_equal(d[["type"]], "Signature250") - expect_equal(d[["fileType"]], "AD2CP") - expect_equal(d[["serialNumber"]], 102791) - # Entry names - expect_equal(sort(names(d[["data"]])), - c("average", "bottomTrack", "burst", "burstAltimeterRaw")) - - expect_equal(sort(names(d[["average"]])), - c("a", "accelerometer", "blankingDistance", "cellSize", - "configuration", "datasetDescription", "distance", - "ensemble", "heading", "magnetometer", "nominalCorrelation", - "numberOfBeams", "numberOfCells", "oceCoordinate", - "orientation", "originalCoordinate", "pitch", "powerLevel", - "pressure", "q", "roll", "soundSpeed", "temperature", - "temperatureMagnetometer", "temperatureRTC", "time", - "transmitEnergy", "v")) - - # Beams and cells - expect_equal(d[["average"]]$oceCoordinate, "beam") - # data$average - a <- d[["average"]] - expect_equal(a$cellSize, 1) - expect_equal(a$blankingDistance, 0.5) - expect_equal(a$numberOfBeams, 4) - expect_equal(a$numberOfCells, 87) - expect_equal(a$blankingDistance, 0.5) - expect_equal(dim(a$v), c(360, 87, 4)) - expect_equal(dim(a$a), c(360, 87, 4)) - expect_equal(dim(a$q), c(360, 87, 4)) - expect_equal(a$v[1:3,1:3,1:3], - structure(c(-0.553, -0.542, -0.545, 2.255, -0.448, 1.695, 2.003, - 0.612, 2.415, 0.647, 0.641, 0.649, 1.701, 1.449, 1.762, - 0.861, 0.971, 1.773, 0.099, 0.065, 0.096, -0.239, -0.235, - -0.217, -0.37, -0.365, -0.393), dim=c(3L, 3L, 3L))) - expect_equal(a$a[1:3,1:3,1:3], - structure(as.raw(c(0x6e, 0x6e, 0x6e, 0x34, 0x35, 0x34, 0x24, 0x22, - 0x24, 0x70, 0x70, 0x70, 0x37, 0x37, 0x36, 0x23, 0x22, - 0x21, 0x67, 0x67, 0x67, 0x6c, 0x6c, 0x6c, 0x4b, 0x4b, - 0x4b)), dim=c(3L, 3L, 3L))) - expect_equal(a$q[1:3,1:3,1:3], - structure(as.raw(c(0x20, 0x21, 0x21, 0x15, 0x0d, 0x19, 0x1d, 0x15, - 0x18, 0x3a, 0x3a, 0x3a, 0x11, 0x15, 0x08, 0x19, 0x1e, - 0x16, 0x55, 0x54, 0x55, 0x58, 0x59, 0x59, 0x4b, 0x4c, - 0x4d)), dim=c(3L, 3L, 3L))) - expect_equal(head(a$time), - structure(c(1653479685.6677, 1653479687.6677, 1653479689.6677, - 1653479691.6677, 1653479693.6677, 1653479695.6677), - class=c("POSIXct", "POSIXt"), tzone="UTC")) - - # bottomTrack -- FIXME - bt <- d[["bottomTrack"]] # FIXME: the values are crazy, e.g. lots of v of order e-15 - - # burst -- FIXME - b <- d[["burst"]] - - # FIXME: values are crazy, e.g. just 1 ASTDistance and ASTPressure, - # and what else is supposed to be there? - - # FIXME: these tests talk of burstAltimeterRaw but I don't think - # this exists in this file. - - #??? # burstAltimeterRaw - #??? bar <- d[["burst"]] - #??? expect_equal("beam", bar$originalCoordinate) - #??? expect_equal("beam", bar$oceCoordinate) - #??? # FIXME: ensemble not checked (and it's always 1, which *must* be wrong) - #??? expect_equal(head(bar$magnetometer$x), - #??? c(356L, 354L, 355L, 355L, 354L, 355L)) - #??? expect_equal(head(bar$magnetometer$y), - #??? c(-310L, -310L, -310L, -311L, -309L, -310L)) - #??? expect_equal(head(bar$magnetometer$z), - #??? c(171L, 171L, 170L, 170L, 169L, 170L)) - #??? expect_equal(head(bar$accelerometer$x), - #??? c(-0.71142578125, -0.71142578125, -0.7119140625, -0.711669921875, - #??? -0.71142578125, -0.711669921875)) - #??? expect_equal(head(bar$accelerometer$y), - #??? c(0.70111083984375, 0.70086669921875, 0.70086669921875, - #??? 0.70086669921875, 0.70111083984375, 0.70062255859375)) - #??? expect_equal(head(bar$accelerometer$z), - #??? c(0.01654052734375, 0.01654052734375, 0.01654052734375, - #??? 0.01654052734375, 0.01654052734375, 0.01678466796875)) - #??? expect_equal(1833L, bar$altimeterRawNumberOfSamples) - #??? expect_equal(bar$altimeterRawSamples[1:3,1:3], - #??? structure(c(2313L, 1542L, 2560L, 2560L, 2442L, 3150L, 2313L, 4570L, - #??? 3579L), dim = c(3L, 3L))) - #??? expect_equal(head(bar$altimeterDistance), - #??? c(42.0308685302734, 42.1037330627441, 42.1036491394043, 40.7197113037109, - #??? 42.1040687561035, 40.7203636169434)) - #??? expect_equal(head(bar$pressure), - #??? c(0.807, 0.801, 0.8, 0.792, 0.808, 0.796)) - #??? expect_true(all("zup" == bar[["orientation"]])) - #??? expect_equal(head(bar$ASTDistance), - #??? c(42.1686553955078, 42.2458877563477, 42.2420387268066, - #??? 40.852237701416, 42.2431640625, 40.8575706481934)) - #??? expect_equal(head(bar$ASTPressure), - #??? c(0.806999981403351, 0.800999999046326, 0.800000011920929, - #??? 0.791999995708466, 0.808000028133392, 0.796000003814697)) - - #??? # Time - #??? expect_equal(head(d[["time"]]), - #??? structure(c(1653479685.6677, 1653479687.6677, 1653479689.6677, - #??? 1653479691.6677, 1653479693.6677, 1653479695.6677), class = - #??? c("POSIXct", "POSIXt"), tzone = "UTC")) - #??? expect_equal(d[["time"]], d[["time", "average"]]) - - #??? # Pressure, temperature etc - #??? expect_equal(head(d[["pressure"]]), - #??? c(0.791, 0.801, 0.807, 0.796, 0.803, 0.799)) - #??? expect_equal(d[["pressure", "average"]], d[["pressure"]]) - #??? expect_equal(head(d[["temperature"]]), - #??? c(20.18, 20.18, 20.18, 20.18, 20.18, 20.18)) - #??? expect_equal(d[["temperature"]], d[["temperature", "average"]]) - #??? expect_equal(head(d[["heading"]]), - #??? c(280.21, 279.75, 279.97, 279.75, 279.72, 279.82)) - #??? expect_equal(d[["heading"]], d[["heading", "average"]]) - #??? expect_equal(head(d[["pitch"]]), - #??? c(-45.4, -45.43, -45.43, -45.41, -45.42, -45.42)) - #??? expect_equal(d[["pitch"]], d[["pitch", "average"]]) - - #??? expect_equal(head(d[["roll"]]), - #??? c(88.64, 88.62, 88.62, 88.64, 88.64, 88.62)) - #??? expect_equal(d[["roll"]], d[["roll", "average"]]) - }) -} - diff --git a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_ctd_aml.R b/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_ctd_aml.R deleted file mode 100644 index 65f7ac85..00000000 --- a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_ctd_aml.R +++ /dev/null @@ -1,19 +0,0 @@ -# vim:textwidth=80:expandtab:shiftwidth=4:softtabstop=4 -library(oce) -file <- system.file("extdata", "ctd_aml.csv", package="oce") - -# https://github.com/dankelley/oce/issues/1891 -test_that("read.ctd.aml() works (issue 1924)", { - ctd <- read.ctd.aml(file) - expect_equal(ctd[["longitude"]], -145.8477) - expect_equal(ctd[["latitude"]], 70.2284 ) - expect_true(is.na(ctd[["serialNumber"]])) - expect_equal(length(ctd[["header"]]), 109L) - expect_equal(head(ctd[["pressure"]],3), - c(0.23, 0.22, 0.22)) - expect_equal(head(ctd[["salinity"]],3), - c(5.57787090635139, 9.97826094600314, 14.628766628731)) - expect_equal(head(ctd[["temperature"]],3), - c(5.671, 5.509, 5.4)) -}) - diff --git a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_ctd_ssda.R b/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_ctd_ssda.R deleted file mode 100644 index 880528f3..00000000 --- a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_ctd_ssda.R +++ /dev/null @@ -1,30 +0,0 @@ -# vim:textwidth=80:expandtab:shiftwidth=4:softtabstop=4 - -# Test Sun & Sea CTD data file. -# https://github.com/dankelley/oce/discussions/1929 -# -# NOTE 2022-08-16: I moved this to a non-CRAN test because it fails on the CRAN -# test machine labelled as r-devel-linux-x86_64-debian-clang. Debugging for -# that machine is not easy, given that rhub hasn't offered a supposedly -# analagous machine for weeks. I moved the test to be local, so at least -# developers can check it, without risking CRAN rejection for a problem. - -library(oce) -file <- "local_data/ctd_ssda.csv" -if (file.exists(file)) { - skip_on_cran() - test_that("read.ctd.ssda() works (discussions/1929)", - { - ctd <- read.oce(file) - expect_equal(ctd[["longitude"]], 15.9990216666667) - expect_equal(ctd[["latitude"]], 55.292085) - expect_equal(length(ctd[["header"]]), 47L) - expect_equal(ctd[["salinity"]], - c(0.08, 0.11, 0.12, 0.12, 0.11, 0.11)) - expect_equal(ctd[["temperature"]], - c(5.007, 4.999, 4.993, 4.988, 4.984, 4.981)) - expect_equal(ctd[["pressure"]], - c(0, -0.01, -0.02, -0.01, -0.02, -0.02)) - }) -} - diff --git a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_hydrographic.R b/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_hydrographic.R deleted file mode 100644 index 0055c62f..00000000 --- a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_hydrographic.R +++ /dev/null @@ -1,86 +0,0 @@ -# vim:textwidth=80:expandtab:shiftwidth=4:softtabstop=4 - -# Test whether base-level [[ can handle hydrographic computations - -library(oce) -data(ctd) - -S <- ctd[["salinity"]] -T <- ctd[["temperature"]] -p <- ctd[["pressure"]] -lon <- ctd[["longitude"]] -lat <- ctd[["latitude"]] -nlevel <- length(S) - -# Object with no location data (for UNESCO testing) -nu <- new("oce") -nu <- oceSetData(nu, "salinity", S) -nu <- oceSetData(nu, "temperature", T) -nu <- oceSetData(nu, "pressure", p) - -# Object with location data (for GSW testing) -ng <- new("oce") -ng <- oceSetData(ng, "salinity", S) -ng <- oceSetData(ng, "temperature", T) -ng <- oceSetData(ng, "pressure", p) -ng <- oceSetMetadata(ng, "longitude", lon) -ng <- oceSetMetadata(ng, "latitude", lat) - -# The two theta values differ by max 4.819825e-6 degC -thetaUNESCO <- swTheta(S, T, p, eos="unesco") -thetaGSW <- swTheta(S, T, p, longitude=lon, latitude=lat, eos="gsw") - -test_that("base-level [[\"?\"]] gives expected names (UNESCO)", { - # using sort() because the order (for some reason I do not understand) is - # different when I do it interactively, versus in the test as set up by - # RStudio. I guess RStudio is using a different default for sorting - # character values. - expect_equal(sort(nu[["?"]]$dataDerived), sort(c("density", "depth", "N2", - paste("potential", "temperature"), "Rrho", "RrhoSF", - "sigmaTheta", paste("sound", "speed"), "SP", "spice", "theta", - "z"))) -}) - -test_that("base-level [[\"?\"]] works on some hydrographic things (UNESCO)", { - options(oceEOS="unesco") - expect_equal(ctd[["theta"]], nu[["theta"]]) - expect_error(nu[["CT"]], "need longitude and latitude to compute") - expect_error(nu[["SA"]], "need longitude and latitude to compute") - expect_error(nu[["Sstar"]], "need longitude and latitude to compute") -}) - - -test_that("base-level [[\"?\"]] gives expected names (GSW)", { - expect_equal(sort(ng[["?"]]$dataDerived), - sort(c(paste("Absolute", "Salinity"), - paste("Conservative", "Temperature"), - "CT", - "density", "depth", "N2", paste("potential", "temperature"), - "Rrho", "RrhoSF", "SA", - paste0("sigma", 0:4), - paste0("spiciness", 0:2), - "sigmaTheta", paste("sound", "speed"), "SP", "spice", - "SR", "Sstar", "theta", "z"))) -}) - -test_that("base-level [[\"?\"]] works on some hydrographic things (GSW)", { - options(oceEOS="gsw") - expect_equal(ctd[["theta"]], ng[["theta"]]) - expect_equal(ctd[["CT"]], ng[["CT"]]) - expect_equal(ctd[["SA"]], ng[["SA"]]) - expect_equal(ctd[["Sstar"]], ng[["Sstar"]]) -}) - -test_that("base-level [[\"?\"]] all names work (UNESCO)", { - options(oceEOS="unesco") - a <- nu[["?"]]$dataDerived - expect_true(all(nlevel == sapply(a, function(i) sum(is.finite(nu[[i]]))))) -}) - -test_that("base-level [[\"?\"]] all names work (GSW)", { - options(oceEOS="gsw") - a <- ng[["?"]]$dataDerived - expect_true(all(nlevel == sapply(a, function(i) sum(is.finite(ng[[i]]))))) -}) - - diff --git a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_missing_file.R b/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_missing_file.R deleted file mode 100644 index 4e691cfd..00000000 --- a/revdep/checks.noindex/oce/old/oce.Rcheck/tests/testthat/test_missing_file.R +++ /dev/null @@ -1,55 +0,0 @@ -library(oce) -test_that("all read() functions give similar errors for missing files", - { - msg <- "cannot find file 'no such file'" - expect_error(read.adp("no such file"), msg) - expect_error(read.adp.ad2cp("no such file"), msg) - expect_error(read.adp.rdi("no such file"), msg) - expect_error(read.adp.nortek("no such file"), msg) - expect_error(read.adp.sontek("no such file"), msg) - expect_error(read.adp.sontek.serial("no such file"), msg) - expect_error(read.adv("no such file"), msg) - expect_error(read.adv.nortek("no such file"), msg) - expect_error(read.adv.sontek.serial("no such file"), msg) - expect_error(read.adv.sontek.adr("no such file"), msg) - expect_error(read.adv.sontek.text("no such file"), msg) - expect_error(read.amsr("no such file"), msg) - expect_error(read.aquadopp("no such file"), msg) - expect_error(read.aquadoppProfiler("no such file"), msg) - expect_error(read.aquadoppHR("no such file"), msg) - expect_error(read.argo("no such file"), msg) - expect_error(read.argo.copernicus("no such file"), msg) - expect_error(read.bremen("no such file"), msg) - expect_error(read.cm("no such file"), msg) - expect_error(read.coastline("no such file"), msg) - expect_error(read.coastline.shapefile("no such file"), msg) - expect_error(read.coastline.openstreetmap("no such file"), msg) - expect_error(read.ctd("no such file"), msg) - expect_error(read.ctd.aml("no such file"), msg) - expect_error(read.ctd.sbe("no such file"), msg) - expect_error(read.ctd.ssda("no such file"), msg) - expect_error(read.ctd.woce("no such file"), msg) - expect_error(read.ctd.woce.other("no such file"), msg) - expect_error(read.ctd.odf("no such file"), msg) - expect_error(read.ctd.odv("no such file"), msg) - expect_error(read.ctd.itp("no such file"), msg) - expect_error(read.echosounder("no such file"), msg) - expect_error(read.g1sst("no such file"), msg) - expect_error(read.gps("no such file"), msg) - expect_error(read.index("no such file"), msg) - expect_error(read.landsat("no such file"), msg) - expect_error(read.lisst("no such file"), msg) - expect_error(read.lobo("no such file"), msg) - expect_error(read.met("no such file"), msg) - expect_error(read.topo("no such file"), msg) - expect_error(read.netcdf("no such file"), msg) - expect_error(read.oce("no such file"), msg) - expect_error(read.odf("no such file"), msg) - expect_error(read.rsk("no such file"), msg) - expect_error(read.sealevel("no such file"), msg) - expect_error(read.section("no such file"), msg) - expect_error(read.woa("no such file"), msg) - expect_error(read.xbt("no such file"), msg) - expect_error(read.xbt.edf("no such file"), msg) - expect_error(read.xbt.noaa1("no such file"), msg) - }) diff --git a/revdep/checks.noindex/seacarb/seacarb_3.3.1.tar.gz b/revdep/checks.noindex/seacarb/seacarb_3.3.1.tar.gz deleted file mode 100644 index e16b848d..00000000 Binary files a/revdep/checks.noindex/seacarb/seacarb_3.3.1.tar.gz and /dev/null differ diff --git a/revdep/checks.noindex/vprr/vprr_0.2.3.tar.gz b/revdep/checks.noindex/vprr/vprr_0.2.3.tar.gz deleted file mode 100644 index 120068c6..00000000 Binary files a/revdep/checks.noindex/vprr/vprr_0.2.3.tar.gz and /dev/null differ diff --git a/revdep/library.noindex/gsw/old/gsw/NEWS.md b/revdep/library.noindex/gsw/old/gsw/NEWS.md deleted file mode 100644 index f29e7d4b..00000000 --- a/revdep/library.noindex/gsw/old/gsw/NEWS.md +++ /dev/null @@ -1,21 +0,0 @@ -1.0-6 -- Update to GSW-C as of 2021-07-06, github commit - `9c10670e89fce906da2cebce3399d73c054e769e`. -- Remove dependency on the 'testthat' package. -- gsw_z_from_p() and gsw_p_from_z() gain parameters geo_strf_dyn_height and - sea_surface_geopotential. -- Relax gsw_geo_strf_dyn_height() test, since values are tied to a new Matlab - interpolation scheme that is not incorporated in GSW-C. - -1.0-5 -- Update to GSW-C 3.05-4. -- Make internal sort routines be machine-independent. - -1.0-4 -- Update to GSW-C 3.05-3. -- Handle NaN values better. -- Add dozens of new GSW functions. - -1.0-3 -- First version, using GSW version 3.03. - diff --git a/revdep/library.noindex/gsw/old/gsw/WORDLIST b/revdep/library.noindex/gsw/old/gsw/WORDLIST deleted file mode 100644 index ca618375..00000000 --- a/revdep/library.noindex/gsw/old/gsw/WORDLIST +++ /dev/null @@ -1,88 +0,0 @@ -CMD -CTD -Compressibility -Elsevier -Enthalpy -Frazil -Geostrophic -Haline -IAPSO -IPV -Isothermal -McDougall -NaN -PSS -RStudio -Rrho -SCOR -SCORE -SCORE -SStar -SeaWater -Sstar -TEOS -Thermobaric -Vaisala -al -argfix -args -bfebf -cabbeling -cebce -centres -circ -colour -compressibility -dCT -dSA -da -dbar -decibars -degC -deltaSA -differencing -dp -drho -dyn -dyn -enthalpy -et -fNsquared -facb -fce -frazil -geo -geopotential -geostrophic -github -gridded -haline -http -https -hydrography -isentropic -isothermal -ito -mS -matlab -md -metres -netcdf -nonfinite -ns -nt -oce -pchip -pppt -ppt -seaice -sealevel -signalled -situ -streamfunction -strf -teos -testthat -thermobaric -unitless -www diff --git a/src/wrappers.c b/src/wrappers.c index 6ba795e7..b6204693 100644 --- a/src/wrappers.c +++ b/src/wrappers.c @@ -31,36 +31,36 @@ void set_up_gsw_data(int *gsw_nx_val, if (!gsw_ny) error("something is wrong with gsw_ny\n"); if (!gsw_nz) error("something is wrong with gsw_nz\n"); - longs_ref = Calloc(gsw_nx, double); + longs_ref = R_Calloc(gsw_nx, double); if (!longs_ref) error("cannot allocate memory for GSW internal data item \"longs_ref\"\n"); for (int i = 0; i < gsw_nx; i++) longs_ref[i] = longs_ref_val[i];; - lats_ref = Calloc(gsw_ny, double); + lats_ref = R_Calloc(gsw_ny, double); if (!lats_ref) error("cannot allocate memory for GSW internal data item \"lats_ref\"\n"); for (int i = 0; i < gsw_ny; i++) lats_ref[i] = lats_ref_val[i];; - p_ref = Calloc(gsw_nz, double); + p_ref = R_Calloc(gsw_nz, double); if (!p_ref) error("cannot allocate memory for GSW internal data item \"p_ref\"\n"); for (int i = 0; i < gsw_nz; i++) p_ref[i] = p_ref_val[i];; // ndepth_ref isn't actually used anywhere, so perhaps it should not be saved. int nxy = gsw_nx * gsw_ny; - ndepth_ref = Calloc(nxy, double); + ndepth_ref = R_Calloc(nxy, double); if (!ndepth_ref) error("cannot allocate memory for GSW internal data item \"ndepth_ref\"\n"); for (int i = 0; i < nxy; i++) ndepth_ref[i] = ndepth_ref_val[i];; int nxyz = gsw_nx * gsw_ny * gsw_nz; - saar_ref = Calloc(nxyz, double); + saar_ref = R_Calloc(nxyz, double); if (!saar_ref) error("cannot allocate memory for GSW internal data item \"saar_ref\"\n"); for (int i = 0; i < nxyz; i++) saar_ref[i] = saar_ref_val[i];; - delta_sa_ref = Calloc(nxyz, double); + delta_sa_ref = R_Calloc(nxyz, double); if (!delta_sa_ref) error("cannot allocate memory for GSW internal data item \"delta_sa_ref\"\n"); for (int i = 0; i < nxyz; i++) delta_sa_ref[i] = delta_sa_ref_val[i];; //Rprintf(" ... done setting up globals\n"); } else { - Rprintf("sarr globals -- already set up\n"); + //Rprintf("sarr globals -- already set up\n"); } } @@ -71,17 +71,17 @@ void clear_gsw_data(void) gsw_nx = 0; gsw_ny = 0; gsw_nz = 0; - Free(longs_ref); + R_Free(longs_ref); longs_ref = NULL; - Free(lats_ref); + R_Free(lats_ref); lats_ref = NULL; - Free(p_ref); + R_Free(p_ref); p_ref = NULL; - Free(ndepth_ref); + R_Free(ndepth_ref); ndepth_ref = NULL; - Free(saar_ref); + R_Free(saar_ref); saar_ref = NULL; - Free(delta_sa_ref); + R_Free(delta_sa_ref); delta_sa_ref = NULL; }