From f7e87e799da6cbd8d5b37e333bcdfa71eb206492 Mon Sep 17 00:00:00 2001
From: Reinhold Kainhofer <reinhold@kainhofer.com>
Date: Sun, 11 Sep 2022 12:44:39 +0200
Subject: [PATCH] V0.0.4: Fix missing documentation for alpha.commision
parameter
---
R/InsuranceParameters.R | 7 +++++++
man/initializeCosts.Rd | 8 ++++++++
2 files changed, 15 insertions(+)
diff --git a/R/InsuranceParameters.R b/R/InsuranceParameters.R
index 42a7aa6..3774dee 100644
--- a/R/InsuranceParameters.R
+++ b/R/InsuranceParameters.R
@@ -52,6 +52,13 @@ setCost = function(costs, type, basis = "SumInsured", frequency = "PolicyPeriod"
#'
#' @param costs (optional) existing cost structure to duplicate / use as a starting point
#' @param alpha Alpha costs (charged once, relative to sum of premiums)
+#' @param alpha.commission Alpha costs (charged during the commission period,
+#' relative to sum of premiums; Use the \code{commissionPeriod}
+#' and \code{alphaCostsCommission} contract parameters
+#' to set the length of the commission period and whether
+#' the \code{alpha.commission} val´ue is understood as yearly
+#' cost or the sum or present value of the commission
+#' charges over the whole commission period)
#' @param Zillmer Zillmer costs (charged once, relative to sum of premiums)
#' @param beta Collection costs (charged on each gross premium, relative to gross premium)
#' @param gamma Administration costs while premiums are paid (relative to sum insured)
diff --git a/man/initializeCosts.Rd b/man/initializeCosts.Rd
index 3e9b403..ae23aba 100644
--- a/man/initializeCosts.Rd
+++ b/man/initializeCosts.Rd
@@ -27,6 +27,14 @@ initializeCosts(
\item{Zillmer}{Zillmer costs (charged once, relative to sum of premiums)}
+\item{alpha.commission}{Alpha costs (charged during the commission period,
+relative to sum of premiums; Use the \code{commissionPeriod}
+and \code{alphaCostsCommission} contract parameters
+to set the length of the commission period and whether
+the \code{alpha.commission} val´ue is understood as yearly
+cost or the sum or present value of the commission
+charges over the whole commission period)}
+
\item{beta}{Collection costs (charged on each gross premium, relative to gross premium)}
\item{gamma}{Administration costs while premiums are paid (relative to sum insured)}
--
GitLab