From 08698e023b1c30a7f6fe8dbebd27bdca1b1abe18 Mon Sep 17 00:00:00 2001 From: Ana Date: Mon, 1 Jul 2019 13:15:48 +0200 Subject: [PATCH] update documentation --- R/HeatStress.R | 15 ++++++++------- README.md | 3 +-- man/HeatStress.Rd | 12 ++++++------ 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/R/HeatStress.R b/R/HeatStress.R index 4d6a076..92c3bf2 100644 --- a/R/HeatStress.R +++ b/R/HeatStress.R @@ -4,13 +4,6 @@ #' #' The package \code{HeatStress} provides methods to calculate heat stress indices. #' -#' Check the details of the indices and input variables: -#' -#' \code{library(HeatStress)} -#' -#' \code{indexShow()} -#' -#' #' #' @details #' @@ -28,6 +21,14 @@ #' \item \code{hi}: Calculation of the heat index (Buzan et al. 2015 and references therein). #' } +#' +#' Check the details of the indices and input variables: +#' +#' \code{library(HeatStress)} +#' +#' \code{indexShow()} +#' +#' #' @name HeatStress #' @docType package #' diff --git a/README.md b/README.md index 749cbfe..efefc4b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ # HeatStress -Heat Stress indices for Heat-Shield ## What is `HeatStress`? -**HeatStress** is a R package for the calculation of heat stress indices. It has been developed in the framework of the Horizon2020 [HEAT-SHIELD project](www.heat-shield.eu). +**HeatStress** is a R package for the calculation of heat stress indices. It has been developed in the framework of the Horizon2020 [HEAT-SHIELD project](https://www.heat-shield.eu). **** diff --git a/man/HeatStress.Rd b/man/HeatStress.Rd index c54be4a..0804f7c 100644 --- a/man/HeatStress.Rd +++ b/man/HeatStress.Rd @@ -11,12 +11,6 @@ Calculate heat stress indices \details{ The package \code{HeatStress} provides methods to calculate heat stress indices. -Check the details of the indices and input variables: - -\code{library(HeatStress)} - -\code{indexShow()} - The following calculation methods are implemented: @@ -32,4 +26,10 @@ The following calculation methods are implemented: \item \code{discomInd}: Calculation of the discomfort index (Coccolo et al. 2016 and references therein). \item \code{hi}: Calculation of the heat index (Buzan et al. 2015 and references therein). } + + Check the details of the indices and input variables: + +\code{library(HeatStress)} + +\code{indexShow()} }