From 8956bb9d580488697bc6884aaa1150444365b708 Mon Sep 17 00:00:00 2001 From: dsheng1026 Date: Sun, 12 Jan 2025 22:13:27 -0500 Subject: [PATCH] udpate function description --- R/HeatStress.R | 3 +++ R/LHR_Hothaps.R | 4 ++-- R/LHR_ISO.R | 1 - 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/R/HeatStress.R b/R/HeatStress.R index 1479713..de04b91 100644 --- a/R/HeatStress.R +++ b/R/HeatStress.R @@ -1,5 +1,8 @@ #' HeatStress #' +#' This function takes specified climate .nc files and a user-specifed heat stress function as arguments, +#' reshapes them, calculates the heat stress and returns as raster +#' #' @param TempRes temporal resolution of input, "day" or "month" #' @param SECTOR choice of sector #' @param HS choice of heat stress function diff --git a/R/LHR_Hothaps.R b/R/LHR_Hothaps.R index 8ced12b..ff1db09 100644 --- a/R/LHR_Hothaps.R +++ b/R/LHR_Hothaps.R @@ -2,8 +2,8 @@ #' #' @param WBGT web bulb globe temperature (C) #' @param workload 'high', 'moderate', 'low' -#' This function is from Foster et al (2021) -#' For additional adjustment, see Smallcombe et al. (2022) +#' This function is from the high occupational temperature health and productivity suppression (Hothaps) programme +#' Derived by Kjellstrom et al. (2018) adopted by Bröde et al. (2018) and Orlov et al. (2020). #' #' @return value of physical work capacity, range from 0 to 1 #' @export diff --git a/R/LHR_ISO.R b/R/LHR_ISO.R index a2c3dbd..be8ac6b 100644 --- a/R/LHR_ISO.R +++ b/R/LHR_ISO.R @@ -2,7 +2,6 @@ #' #' @param WBGT relative humidity (%) #' @param workload 'high', 'moderate', 'low', specifying the rate of metabolic heat production (Watts) -#' This function is from Kjellstrom et al. (2014) #' Based on Kjellstrom et al (2009): #' M = 200W for office desk work and service industries #' M = 300W for average manufacturing industry work