R/variance.factor.R

Defines functions variance.factor

Documented in variance.factor

#' Title
#'
#' @param distribution 
#' @param type 
#' @param quantile.of.interest 
#' @param proportion.failing 
#' @param number.points 
#' @param ... 
#'
#' @return NULL
#' @export
#'
#' @examples
#' \dontrun{
#' 
#' # For the normal distribution
#' variance.factor(distribution = 'normal', 
#'                 type = 'quantile', 
#'                 quantile.of.interest = 0.02,
#'                 proportion.failing = 0.2)
#' 
#' 
#' # For the smallest extreme value distribution
#' variance.factor(distribution = 'sev',
#'                 type = 'quantile', 
#'                 quantile.of.interest = 0.02,
#'                 proportion.failing = 0.2)
#' }
variance.factor <- 
  function(distribution = NULL, type = 'quantile', 
           quantile.of.interest = NULL, proportion.failing = NULL,
           number.points = 200,...) {

  if(!(tolower(type)%in%c('quantile', 'hazard'))) stop("\nArgument type must be either 'quantile' or 'hazard'")

  if(tolower(type)=='hazard') {
    
    hazard.var.fact(distribution = distribution, 
                                           number.points = number.points)
} else {
    
  if(is.null(proportion.failing) & is.null(quantile.of.interest)) {
    
    quantile.var.fact(x = distribution, number.points = number.points)
    
} else {
    
    if(is.null(proportion.failing) | is.null(quantile.of.interest)) stop('\nQuantile.of.interest and proportion.failing must be specified')

  single.quantile.var.fact(quant.of.interest = quantile.of.interest, 
                           proportion.failing = proportion.failing,
                           distribution = distribution)    
}}
                                                                                  
  
  
  
  
  
}
Auburngrads/SMRD documentation built on Sept. 14, 2020, 2:21 a.m.