[Returnanalytics-commits] r3821 - in pkg/Dowd: R man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Wed Jul 15 01:18:48 CEST 2015
Author: dacharya
Date: 2015-07-15 01:18:47 +0200 (Wed, 15 Jul 2015)
New Revision: 3821
Added:
pkg/Dowd/R/LogNormalESPlot2DHP.R
pkg/Dowd/man/LogNormalESPlot2DHP.Rd
Log:
Function LogNormalESPlot2DHP added.
Added: pkg/Dowd/R/LogNormalESPlot2DHP.R
===================================================================
--- pkg/Dowd/R/LogNormalESPlot2DHP.R (rev 0)
+++ pkg/Dowd/R/LogNormalESPlot2DHP.R 2015-07-14 23:18:47 UTC (rev 3821)
@@ -0,0 +1,135 @@
+#' Plots log normal ES against holding period
+#'
+#' Plots the ES of a portfolio against holding period assuming that geometric returns are
+#' normal distributed, for specified confidence level and holding period.
+#'
+#' @param returns Vector of daily geometric return data
+#' @param mu Mean of daily geometric return data
+#' @param sigma Standard deviation of daily geometric return data
+#' @param investment Size of investment
+#' @param cl ES confidence level and must be a scalar
+#' @param hp ES holding period and must be a vector
+#'
+#' @note The input arguments contain either return data or else mean and
+#' standard deviation data. Accordingly, number of input arguments is either 4
+#' or 5. In case there 4 input arguments, the mean and standard deviation of
+#' data is computed from return data. See examples for details.
+#'
+#' @references Dowd, K. Measuring Market Risk, Wiley, 2007.
+#'
+#' @author Dinesh Acharya
+#' @examples
+#'
+#' # Computes ES given geometric return data
+#' data <- runif(5, min = 0, max = .2)
+#' LogNormalESPlot2DHP(returns = data, investment = 5, cl = .95, hp = 60:90)
+#'
+#' # Computes v given mean and standard deviation of return data
+#' LogNormalESPlot2DHP(mu = .012, sigma = .03, investment = 5, cl = .99, hp = 40:80)
+#'
+#'
+#' @export
+LogNormalESPlot2DHP <- function(...){
+ # Determine if there are four or five arguments, and ensure that arguments are read as intended
+ if (nargs() < 4) {
+ stop("Too few arguments")
+ }
+ if (nargs() > 5) {
+ stop("Too many arguments")
+ }
+ args <- list(...)
+ if (nargs() == 5) {
+ mu <- args$mu
+ investment <- args$investment
+ cl <- args$cl
+ sigma <- args$sigma
+ hp <- args$hp
+ }
+ if (nargs() == 4) {
+ mu <- mean(args$returns)
+ investment <- args$investment
+ cl <- args$cl
+ sigma <- sd(args$returns)
+ hp <- args$hp
+ }
+
+ # Check that inputs have correct dimensions
+ mu <- as.matrix(mu)
+ mu.row <- dim(mu)[1]
+ mu.col <- dim(mu)[2]
+ if (max(mu.row, mu.col) > 1) {
+ stop("Mean must be a scalar")
+ }
+ sigma <- as.matrix(sigma)
+ sigma.row <- dim(sigma)[1]
+ sigma.col <- dim(sigma)[2]
+ if (max(sigma.row, sigma.col) > 1) {
+ stop("Standard deviation must be a scalar")
+ }
+ cl <- as.matrix(cl)
+ cl.row <- dim(cl)[1]
+ cl.col <- dim(cl)[2]
+ if (max(cl.row, cl.col) > 1) {
+ stop("Confidence level must be a scalar")
+ }
+ hp <- as.matrix(hp)
+ hp.row <- dim(hp)[1]
+ hp.col <- dim(hp)[2]
+ if (min(hp.row, hp.col) > 1) {
+ stop("Holding period must be a vector")
+ }
+
+ # Check that hp is read as row vector
+ if (hp.row > hp.col) {
+ hp <- t(hp)
+ }
+
+ # Check that inputs obey sign and value restrictions
+ if (sigma < 0) {
+ stop("Standard deviation must be non-negative")
+ }
+ if (max(cl) >= 1){
+ stop("Confidence levels must be less than 1")
+ }
+ if (min(cl) <= 0){
+ stop("Confidence levels must be greater than 0")
+ }
+ if (min(hp) <= 0){
+ stop("Holding Period must be greater than 0")
+ }
+ # VaR estimation
+
+ cl.row <- dim(cl)[1]
+ cl.cl <- dim(cl)[2]
+ VaR <- investment - exp(sigma[1,1] * sqrt(t(hp)) * qnorm(1 - cl[1,1], 0, 1)
+ + mu[1,1] * t(hp) %*% matrix(1, cl.row, cl.col) + log(investment)) # VaR
+
+ # ES etimation
+ n <- 1000 # Number of slices into which tail is divided
+ cl0 <- cl # Initial confidence level
+ delta.cl <- (1 - cl) / n # Increment to confidence level as each slice is taken
+ w <- VaR
+ for (i in 1:(n-1)) {
+ cl <- cl0 + i * delta.cl # Revised cl
+ w <- w + investment - exp(sigma[1,1] * sqrt(t(hp)) *
+ qnorm(1 - cl[1,1], 0, 1) + mu[1,1] * t(hp) %*%
+ matrix(1, cl.row, cl.col) + log(investment))
+ }
+ es <- w/n
+
+ # Plotting
+ plot(hp, es, type = "l", xlab = "Holding Period", ylab = "ES")
+ title("Log normal ES against holding period")
+ cl.label <- 100*cl0
+ xmin <-min(hp)+.25*(max(hp)-min(hp))
+ text(xmin,max(es)-.1*(max(es)-min(es)),
+ 'Input parameters', cex=.75, font = 2)
+ text(xmin,max(es)-.15*(max(es)-min(es)),
+ paste('Daily mean geometric return = ',mu[1,1]),cex=.75)
+ text(xmin,max(es)-.2*(max(es)-min(es)),
+ paste('Stdev. of daily geometric returns = ',sigma[1,1]),cex=.75)
+ text(xmin,max(es)-.25*(max(es)-min(es)),
+ paste('Investment size = ',investment),cex=.75)
+ text(xmin,max(es)-.3*(max(es)-min(es)),
+ paste('Confidence level = ',cl.label,'%'),cex=.75)
+}
Added: pkg/Dowd/man/LogNormalESPlot2DHP.Rd
===================================================================
--- pkg/Dowd/man/LogNormalESPlot2DHP.Rd (rev 0)
+++ pkg/Dowd/man/LogNormalESPlot2DHP.Rd 2015-07-14 23:18:47 UTC (rev 3821)
@@ -0,0 +1,46 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/LogNormalESPlot2DHP.R
+\name{LogNormalESPlot2DHP}
+\alias{LogNormalESPlot2DHP}
+\title{Plots log normal ES against holding period}
+\usage{
+LogNormalESPlot2DHP(...)
+}
+\arguments{
+\item{returns}{Vector of daily geometric return data}
+
+\item{mu}{Mean of daily geometric return data}
+
+\item{sigma}{Standard deviation of daily geometric return data}
+
+\item{investment}{Size of investment}
+
+\item{cl}{ES confidence level and must be a scalar}
+
+\item{hp}{ES holding period and must be a vector}
+}
+\description{
+Plots the ES of a portfolio against holding period assuming that geometric returns are
+normal distributed, for specified confidence level and holding period.
+}
+\note{
+The input arguments contain either return data or else mean and
+ standard deviation data. Accordingly, number of input arguments is either 4
+ or 5. In case there 4 input arguments, the mean and standard deviation of
+ data is computed from return data. See examples for details.
+}
+\examples{
+# Computes ES given geometric return data
+ data <- runif(5, min = 0, max = .2)
+ LogNormalESPlot2DHP(returns = data, investment = 5, cl = .95, hp = 60:90)
+
+ # Computes v given mean and standard deviation of return data
+ LogNormalESPlot2DHP(mu = .012, sigma = .03, investment = 5, cl = .99, hp = 40:80)
+}
+\author{
+Dinesh Acharya
+}
+\references{
+Dowd, K. Measuring Market Risk, Wiley, 2007.
+}
+
More information about the Returnanalytics-commits
mailing list