diff --git a/DESCRIPTION b/DESCRIPTION index f6d9635..69bdbb2 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,21 +1,20 @@ Package: mobirep Title: Models Bivariate Dependence and Produces Bivariate Return Periods -Version: 0.2.2 +Version: 0.2.3 Authors@R: person(given = "Alois", family = "Tilloy", role = c("aut", "cre"), email = "alois.tilloy@kcl.ac.uk", comment = c(ORCID = "https://orcid.org/0000-0002-5881-0642")) -Description: Provides a set of function that model the - dependence between two variables in the extremes, select most - relevant models, estimate bivariate return periods and create - bivariate level curves. - references supporting the methods used in the package: - main article: Tilloy et al. (2020) - supporting references for condtional extremes model:Heffernan and Tawn (2004) - supporting reference for Jt-KDE model: Cooley et al. (2019) - supporting reference for copula modelling: Nelsen (2006) +Description: Models the dependence between two variables in the extremes, select most + relevant models, estimate bivariate return periods and create bivariate level curves. + Methods used in the package are described in the following reference: + Tilloy, Malamud, Winter and Joly-Laugel (2020) + Supporting references for the conditional extremes model, Jt-KDE model and for copula modelling are the following: + Heffernan and Tawn (2004) + Cooley, Thibaud, Castillo and Wehner (2019) + Nelsen (2006) . License: GPL (>= 3) Encoding: UTF-8 LazyData: True diff --git a/R/porto_data.R b/R/porto_data.R index 560059c..d8f555f 100644 --- a/R/porto_data.R +++ b/R/porto_data.R @@ -1,22 +1,28 @@ #' Fire and extreme temperature in portugal #' -#' Data from a QTL experiment on gravitropism in -#' Arabidopsis, with data on 162 recombinant inbred lines (Ler x -#' Cvi). The outcome is the root tip angle (in degrees) at two-minute -#' increments over eight hours. +#' Bivariate dataset of daily mean temperature and number of wildfires in the Porto +#' district (Portugal) for the period 1980 to 2005. Daily mean temperature data +#' from E-OBS (Cornes et al. (2018) +#' and wildfire data from Pereira et al. (2011) <10.5194/nhess-11-3343-2011>. + #' #' @docType data #' #' @usage data(porto) #' -#' @format An object of class \code{"cross"}; see \code{\link[qtl]{read.cross}}. -#' +#' @format A dataframe composed of two column: +#' #' \itemize{ +#' \item temp2.temperature (mean daily temperature in °C) +#' \item temp2.nb (daily number of wildfires) +#'} #' @keywords datasets #' -#' @references Tilloy et al. (2020) +#' @references +#' Tilloy, A., Malamud, B.D., Winter, H. and Joly-Laugel, A., 2020. +#' Evaluating the efficacy of bivariate extreme modelling approaches +#' for multi-hazard scenarios. Natural Hazards and Earth System Sciences, 20(8), pp.2091-2117. "fire01meantemp" -#' #' #' @examples #' data(porto) diff --git a/R/supplement.funct.R b/R/supplement.funct.R index eca9363..1b20aec 100644 --- a/R/supplement.funct.R +++ b/R/supplement.funct.R @@ -1,6 +1,6 @@ -#' Automatically select analaugous datasets from the 60 datasets created in Tilloy et al.(2020) -#' see: https://nhess.copernicus.org/articles/20/2091/2020/nhess-20-2091-2020.html for more detaila +#' Automatically select analaugous datasets from the 60 datasets created in Tilloy et al.(2020). +#' See: https://nhess.copernicus.org/articles/20/2091/2020/nhess-20-2091-2020.html for more detail. #' #' @param u2 Two column data frame #' @export