[Returnanalytics-commits] r3816 - in pkg/Dowd: R man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Mon Jul 13 14:04:58 CEST 2015
Author: dacharya
Date: 2015-07-13 14:04:58 +0200 (Mon, 13 Jul 2015)
New Revision: 3816
Added:
pkg/Dowd/R/LogNormalESPlot2DCL.R
pkg/Dowd/man/LogNormalESPlot2DCL.Rd
Log:
Function LogNormalESPlot2DCL added.
Added: pkg/Dowd/R/LogNormalESPlot2DCL.R
===================================================================
--- pkg/Dowd/R/LogNormalESPlot2DCL.R (rev 0)
+++ pkg/Dowd/R/LogNormalESPlot2DCL.R 2015-07-13 12:04:58 UTC (rev 3816)
@@ -0,0 +1,133 @@
+#' Plots log normal ES against confidence level
+#'
+#' Plots the ES of a portfolio against confidence level assuming that geometric returns are
+#' normally 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 vector
+#' @param hp ES holding period and must be a scalar
+#'
+#' @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
+#'
+#' # Plots ES against confidence level
+#' data <- runif(5, min = 0, max = .2)
+#' LogNormalESPlot2DCL(returns = data, investment = 5, cl = seq(.9,.99,.01), hp = 60)
+#'
+#' # Plots ES against confidence level
+#' LogNormalESPlot2DCL(mu = .012, sigma = .03, investment = 5, cl = seq(.9,.99,.01), hp = 40)
+#'
+#'
+#' @export
+LogNormalESPlot2DCL <- 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 (min(cl.row, cl.col) > 1) {
+ stop("Confidence level must be a vector")
+ }
+ hp <- as.matrix(hp)
+ hp.row <- dim(hp)[1]
+ hp.col <- dim(hp)[2]
+ if (max(hp.row, hp.col) > 1) {
+ stop("Holding period must be a scalar")
+ }
+
+ # Check that hp is read as row vector
+ if (cl.row > cl.col) {
+ cl <- t(cl)
+ }
+
+ # 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.col <- dim(cl)[2]
+ VaR <- investment - exp(sigma[1,1] * sqrt(hp[1,1]) * qnorm(1 - cl, 0, 1)
+ + mu[1,1] * hp[1,1] * 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
+ v <- VaR
+ for (i in 1:(n-1)) {
+ cl <- cl0 + i * delta.cl # Revised cl
+ v <- v + investment - exp(sigma[1,1] * sqrt(hp[1,1]) *
+ qnorm(1 - cl, 0, 1) + mu[1,1] * hp[1,1] *
+ matrix(1, cl.row, cl.col) + log(investment))
+ }
+ v <- v/n
+
+ # Plotting
+ plot(cl0, v, type = "l", xlab = "Holding Period", ylab = "ES")
+ title("Log Normal ES against holding period")
+ xmin <-min(cl0)+.25*(max(cl0)-min(cl0))
+ text(xmin,max(v)-.1*(max(v)-min(v)),
+ 'Input parameters', cex=.75, font = 2)
+ text(xmin,max(v)-.15*(max(v)-min(v)),
+ paste('Daily mean geometric return = ',round(mu[1,1],3)),cex=.75)
+ text(xmin,max(v)-.2*(max(v)-min(v)),
+ paste('Stdev. of daily geometric returns = ',round(sigma[1,1],3)),cex=.75)
+ text(xmin,max(v)-.25*(max(v)-min(v)),
+ paste('Investment size = ',investment),cex=.75)
+ text(xmin,max(v)-.3*(max(v)-min(v)),
+ paste('Holding Period = ',hp),cex=.75)
+}
Added: pkg/Dowd/man/LogNormalESPlot2DCL.Rd
===================================================================
--- pkg/Dowd/man/LogNormalESPlot2DCL.Rd (rev 0)
+++ pkg/Dowd/man/LogNormalESPlot2DCL.Rd 2015-07-13 12:04:58 UTC (rev 3816)
@@ -0,0 +1,46 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/LogNormalESPlot2DCL.R
+\name{LogNormalESPlot2DCL}
+\alias{LogNormalESPlot2DCL}
+\title{Plots log normal ES against confidence level}
+\usage{
+LogNormalESPlot2DCL(...)
+}
+\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 vector}
+
+\item{hp}{ES holding period and must be a scalar}
+}
+\description{
+Plots the ES of a portfolio against confidence level assuming that geometric returns are
+normally 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{
+# Plots ES against confidence level
+ data <- runif(5, min = 0, max = .2)
+ LogNormalESPlot2DCL(returns = data, investment = 5, cl = seq(.9,.99,.01), hp = 60)
+
+ # Plots ES against confidence level
+ LogNormalESPlot2DCL(mu = .012, sigma = .03, investment = 5, cl = seq(.9,.99,.01), hp = 40)
+}
+\author{
+Dinesh Acharya
+}
+\references{
+Dowd, K. Measuring Market Risk, Wiley, 2007.
+}
+
More information about the Returnanalytics-commits
mailing list