Merge pull request #3598 from dlebauer/saturated_vapor_pressure

Quick update to #3597: export and document t2es alias; add venv/ to .Rbuildignore

Author: dlebauer

modules/data.atmosphere/.Rbuildignore

@@ -1,3 +1,4 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
 ^docs$
+.*venv/

modules/data.atmosphere/NAMESPACE

@@ -105,6 +105,7 @@ export(split_wind)
 export(subdaily_pred)
 export(sw2par)
 export(sw2ppfd)
+export(t2es)
 export(temporal.downscale.functions)
 export(temporal_downscale_half_hour)
 export(upscale_met)

modules/data.atmosphere/R/metutils.R

@@ -103,6 +103,17 @@ get.vpd <- function(rh, temp) {
 #' WMO (2014) Guide to Instruments and Methods of Observation (WMO-No. 8), ch. 4.
 #' @md
 #' @author David LeBauer
+#' @examples
+#' # Calculate saturation vapor pressure at 20°C
+#' sat_vapor_pressure(20)
+#' t2es(20)
+#' 
+#' # Using different methods
+#' t2es(c(10, 20, 30), method = "Magnus")
+#' t2es(283.15, temp_units = "K", method = "GoffGratch")
+#' 
+#' # Different output units
+#' t2es(20, out_units = "hPa")
 #' @export
 sat_vapor_pressure <- function(
     temp,
@@ -158,6 +169,12 @@ get.es <- function(temp) {
   )
 }
 
+#' @rdname sat_vapor_pressure
+#' @export
+t2es <- function(temp, temp_units = "degC", out_units = "kPa", method = "ClausiusClapeyron") {
+  sat_vapor_pressure(temp = temp, temp_units = temp_units, out_units = out_units, method = method)
+}
+
 ##' Calculate RH from temperature and dewpoint
 ##'
 ##' Based on equation 12 in Lawrence 2005, The Relationship between

modules/data.atmosphere/man/sat_vapor_pressure.Rd

@@ -1,3 +1,4 @@
 contrib
 data-raw
 ^docs$
+.*venv/