[Returnanalytics-commits] r3806 - pkg/Dowd/R

[noreply at r-forge.r-project.org]

Author: dacharya
Date: 2015-07-13 13:38:38 +0200 (Mon, 13 Jul 2015)
New Revision: 3806

Modified:
   pkg/Dowd/R/LogtESPlot3D.R
Log:
Minor mistakes in documentation.

Modified: pkg/Dowd/R/LogtESPlot3D.R
===================================================================
--- pkg/Dowd/R/LogtESPlot3D.R	2015-07-13 11:37:52 UTC (rev 3805)
+++ pkg/Dowd/R/LogtESPlot3D.R	2015-07-13 11:38:38 UTC (rev 3806)
@@ -22,16 +22,17 @@
 #' @author Dinesh Acharya
 #' @examples
 #' 
-#'    # Plots VaR against confidene level given geometric return data
+#'    # Plots ES against confidene level given geometric return data
 #'    data <- runif(5, min = 0, max = .2)
 #'    LogtESPlot3D(returns = data, investment = 5, df = 6, cl = seq(.85,.99,.01), hp = 60:90)
 #'    
-#'    # Computes VaR against confidence level given mean and standard deviation of return data
+#'    # Computes ES against confidence level given mean and standard deviation of return data
 #'    LogtESPlot3D(mu = .012, sigma = .03, investment = 5, df = 6, cl = seq(.85,.99,.02), hp = 40:80)
 #'
 #'
 #' @export
 LogtESPlot3D <- function(...){
+  # Determine if there are four or five arguments, and ensure that arguments are read as intended
   if (nargs() < 5) {
     stop("Too few arguments")
   }