R/var_of_gumbel_function.R

In niknap/ScalingFunctions: Collection of functions for scaling of distributions

# Copyright (C) 2019 Dr. Nikolai Knapp, UFZ
#
# This file is part of the ScalingFunctions R package.
#
# The ScalingFunctions R package is free software: you can redistribute
# it and/or modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ScalingFunctions is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ScalingFunctions. If not, see <http://www.gnu.org/licenses/>.



#' Variance of gumbel distribution
#'
#' Calculation of the variance of a gumbel
#' distribution from function parameter
#' @param scale Scale parameter of the gumbel distribution
#' @return Variance of gumbel distribution
#' @author Nikolai Knapp, nikolai.knapp@ufz.de

var_of_gumbel <- function(scale){
  var <- pi^2/6*scale^2
  names(var) <- "var"
  return(var)
}