From 8f1fb9e3f8ab8cad4e21578f8a2c54af594ba7b5 Mon Sep 17 00:00:00 2001
From: gpitt71 <93520106+gpitt71@users.noreply.github.com>
Date: Thu, 18 Apr 2024 09:44:00 +0200
Subject: [PATCH] Extra arguments documented.

---
 R/{plotresidualsclmplusmodel.R => plotclmplusmodel.R} | 5 ++++-
 R/predictclmplusmodel.R                               | 1 +
 man/plot.clmplusmodel.Rd                              | 6 ++++--
 man/predict.clmplusmodel.Rd                           | 2 ++
 4 files changed, 11 insertions(+), 3 deletions(-)
 rename R/{plotresidualsclmplusmodel.R => plotclmplusmodel.R} (95%)

diff --git a/R/plotresidualsclmplusmodel.R b/R/plotclmplusmodel.R
similarity index 95%
rename from R/plotresidualsclmplusmodel.R
rename to R/plotclmplusmodel.R
index 81244c3..184644e 100644
--- a/R/plotresidualsclmplusmodel.R
+++ b/R/plotclmplusmodel.R
@@ -4,6 +4,8 @@
 #' 
 #' @param clmplusmodel clmplusmodel object to be plotted.
 #' @param heat.lim limits in the residuals plot.
+#' @param ... Extra arguments to be passed to the plot function.
+#' 
 #' @examples
 #' data(sifa.mtpl)
 #' sifa.mtpl.rtt <- AggregateDataPP(cumulative.payments.triangle=sifa.mtpl)
@@ -19,7 +21,8 @@
 #' 
 #' @export
 plot.clmplusmodel <- function(clmplusmodel,
-                              heat.lim=c(-2.5,2.5)){
+                              heat.lim=c(-2.5,2.5),
+                              ...){
   
   if((clmplusmodel$apc_input$hazard.model %in% names(pkg.env$models))|(clmplusmodel$apc_input$hazard.model=="user.defined")){
     
diff --git a/R/predictclmplusmodel.R b/R/predictclmplusmodel.R
index 88a2d62..53c1fe0 100644
--- a/R/predictclmplusmodel.R
+++ b/R/predictclmplusmodel.R
@@ -8,6 +8,7 @@
 #' @param gk.order \code{integer}, order of the arima model with drift for the accident year effect extrapolation. Default to (1,1,0).
 #' @param ckj.order \code{integer}, order of the arima model with drift for the calendar year effect extrapolation. Default to (0,1,0).
 #' @param forecasting_horizon \code{integer}, between 1 and the triangle width. Calendar periods ahead for the predictions. Default predictions are to run-off. 
+#' @param ... Extra arguments to be passed to the predict function.
 #' 
 #' @return Returns the following output:
 #'   
diff --git a/man/plot.clmplusmodel.Rd b/man/plot.clmplusmodel.Rd
index d667468..0af7ba9 100644
--- a/man/plot.clmplusmodel.Rd
+++ b/man/plot.clmplusmodel.Rd
@@ -1,15 +1,17 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/plotresidualsclmplusmodel.R
+% Please edit documentation in R/plotclmplusmodel.R
 \name{plot.clmplusmodel}
 \alias{plot.clmplusmodel}
 \title{Plot the hazard model residuals}
 \usage{
-\method{plot}{clmplusmodel}(clmplusmodel, heat.lim = c(-2.5, 2.5))
+\method{plot}{clmplusmodel}(clmplusmodel, heat.lim = c(-2.5, 2.5), ...)
 }
 \arguments{
 \item{clmplusmodel}{clmplusmodel object to be plotted.}
 
 \item{heat.lim}{limits in the residuals plot.}
+
+\item{...}{Extra arguments to be passed to the plot function.}
 }
 \value{
 No return value, plots the hazard model residuals in triangular form.
diff --git a/man/predict.clmplusmodel.Rd b/man/predict.clmplusmodel.Rd
index 8a9371d..cc31f12 100644
--- a/man/predict.clmplusmodel.Rd
+++ b/man/predict.clmplusmodel.Rd
@@ -26,6 +26,8 @@
 \item{ckj.order}{\code{integer}, order of the arima model with drift for the calendar year effect extrapolation. Default to (0,1,0).}
 
 \item{forecasting_horizon}{\code{integer}, between 1 and the triangle width. Calendar periods ahead for the predictions. Default predictions are to run-off.}
+
+\item{...}{Extra arguments to be passed to the predict function.}
 }
 \value{
 Returns the following output: