From 8038ba851e8cd67393b802eb448efbbb9bc3d9be Mon Sep 17 00:00:00 2001 From: Daniel Schlaepfer Date: Tue, 26 Nov 2024 15:18:06 -0500 Subject: [PATCH] Improve documentation of sw_upgrade() - documentation now includes the changes to classes "swWeather" and "swWeatherData" with v6.0.0 --- .Rbuildignore | 2 +- .gitignore | 2 +- R/A_swGenericMethods.R | 8 ++++++++ man/sw_upgrade.Rd | 8 ++++++++ 4 files changed, 18 insertions(+), 2 deletions(-) diff --git a/.Rbuildignore b/.Rbuildignore index 034b3b4d..dd1aedc6 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -12,7 +12,7 @@ ^cran-comments\.md$ ^NEWS\.md$ ^tests/ -tests/rSOILWAT_IntegrationTestOutput +tests/rSOILWAT_IntegrationTestOutput* src/SOILWAT2/\.git src/SOILWAT2/\.github src/SOILWAT2/doc diff --git a/.gitignore b/.gitignore index 111e5ec5..8b02902b 100644 --- a/.gitignore +++ b/.gitignore @@ -34,7 +34,7 @@ Thumbs.db # Package check files ..Rcheck rSOILWAT2.Rcheck -rSOILWAT_IntegrationTestOutput/ +rSOILWAT_IntegrationTestOutput* tests/spelling.Rout.save backup/ diff --git a/R/A_swGenericMethods.R b/R/A_swGenericMethods.R index cb380936..a4a90644 100644 --- a/R/A_swGenericMethods.R +++ b/R/A_swGenericMethods.R @@ -224,6 +224,14 @@ format_timestamp <- function(object) { #' * class [`swFiles-class`]: #' `SWRC` parameter input file added as file 6 for a new total of 23 #' * class [`swProd-class`]: new slot `"veg_method"` +#' * class [`swWeatherData`]: new slots `"use_cloudCoverMonthly"`, +#' `"use_windSpeedMonthly"`, `"use_humidityMonthly"`, +#' `"dailyInputFlags"`, and `"desc_rsds"` +#' * class [`swWeatherData`]: slot `"data"` gained 11 new columns: +#' `"cloudCov_pct"`, `"windSpeed_mPERs"`, `"windSpeed_east_mPERs"`, +#' `"windSpeed_north_mPERs"`, `"rHavg_pct"`, `"rHmax_pct"`, +#' `"rHmin_pct"`, `"specHavg_pct"`, `"Tdewpoint_C"`, `"actVP_kPa"`, +#' and `"shortWR"` #' * Changes with `v5.4.0`: #' * classes [`swEstabSpecies-class`] and [`swEstab-class`]: #' new slot `"vegType"` diff --git a/man/sw_upgrade.Rd b/man/sw_upgrade.Rd index 2570d96e..81dce5e4 100644 --- a/man/sw_upgrade.Rd +++ b/man/sw_upgrade.Rd @@ -104,6 +104,14 @@ new slots \code{"swrc_flags"}, \code{"has_swrcp"}, and \item class \code{\linkS4class{swFiles}}: \code{SWRC} parameter input file added as file 6 for a new total of 23 \item class \code{\linkS4class{swProd}}: new slot \code{"veg_method"} +\item class \code{\link{swWeatherData}}: new slots \code{"use_cloudCoverMonthly"}, +\code{"use_windSpeedMonthly"}, \code{"use_humidityMonthly"}, +\code{"dailyInputFlags"}, and \code{"desc_rsds"} +\item class \code{\link{swWeatherData}}: slot \code{"data"} gained 11 new columns: +\code{"cloudCov_pct"}, \code{"windSpeed_mPERs"}, \code{"windSpeed_east_mPERs"}, +\code{"windSpeed_north_mPERs"}, \code{"rHavg_pct"}, \code{"rHmax_pct"}, +\code{"rHmin_pct"}, \code{"specHavg_pct"}, \code{"Tdewpoint_C"}, \code{"actVP_kPa"}, +and \code{"shortWR"} } \item Changes with \code{v5.4.0}: \itemize{