From 47c3bca3c758d99ece79a1547f86c3d707d2b782 Mon Sep 17 00:00:00 2001
From: Reinhold Kainhofer <reinhold@kainhofer.com>
Date: Mon, 9 Nov 2020 09:30:56 +0100
Subject: [PATCH] Re-generate docs
---
man/InsuranceContract.ParameterDefaults.Rd | 11 +++++++++++
man/InsuranceContract.Rd | 5 +++++
man/InsuranceTarif.Rd | 4 +++-
3 files changed, 19 insertions(+), 1 deletion(-)
diff --git a/man/InsuranceContract.ParameterDefaults.Rd b/man/InsuranceContract.ParameterDefaults.Rd
index cc60d3b..99fb0aa 100644
--- a/man/InsuranceContract.ParameterDefaults.Rd
+++ b/man/InsuranceContract.ParameterDefaults.Rd
@@ -41,6 +41,9 @@ for single-premium contracts.
contracts with multiple parts, e.g. dynamic increases),
default = "Hauptvertrag"}
\item{\code{$sumInsured}}{Sum insured, default = 100,000}
+\item{\code{$initialCapital}}{Reserve/Capital that is already available
+at contract inception, e.g. from a previous contract. No tax
+or acquisition costs are applied to this capital.}
\item{\code{$YOB}}{Year of birth of the insured, used to determine the
age for the application of the mortality table}
\item{\code{$age}}{Age of the insured}
@@ -144,7 +147,15 @@ are calculated. Value of type \link{Date}, typically generated with
month are relevant.}
\item{\code{$balanceSheetMethod}}{How to interpolate the balance sheet
reserves (at the balandeSheetDate) from the yearly contractual
+reserves. Either a string "30/360", "act/act", "act/360", "act/365"
+or a function with signature \code{balanceSheetMethod(params, contractDates, balanceDates)}
+that returns a vector of coefficients for each year to
+interpolate the reserves available at the given \code{contractDates}
+for the desirec \code{balanceDates}}}
reserves.}
+\item{\code{$unearnedPremiumsMethod}}{How to calculate the unearned
+premiums (considering the balance sheet date and the premium
+frequency). A function with signature \code{unearnedPremiumsMethod(params, dates)}}
\item{\code{$surrenderValueCalculation}}{A function describing the surrender
value calculation.}
\item{\code{$premiumFrequencyOrder}}{Order of the approximation for
diff --git a/man/InsuranceContract.Rd b/man/InsuranceContract.Rd
index e952c14..aa65807 100644
--- a/man/InsuranceContract.Rd
+++ b/man/InsuranceContract.Rd
@@ -559,6 +559,7 @@ Calculate all time series of the contract from the parameters
valuesFrom = 0,
premiumCalculationTime = 0,
preservePastPV = TRUE,
+ additionalCapital = 0,
recalculatePremiums = TRUE,
recalculatePremiumSum = TRUE,
history_comment = NULL,
@@ -590,6 +591,10 @@ they no longer represent the actual contract state at these
times. If values are not recalculated, the reserves at each
time step represent the proper state at that point in time.}
+\item{\code{additionalCapital}}{The capital that is added to the contract
+(e.g. capital carried over from a previous contract) at the
+premium calculation time.}
+
\item{\code{recalculatePremiums}}{Whether the premiums should be recalculated
at time \code{premiumCalculationTime} at all.}
diff --git a/man/InsuranceTarif.Rd b/man/InsuranceTarif.Rd
index 872286f..81de465 100644
--- a/man/InsuranceTarif.Rd
+++ b/man/InsuranceTarif.Rd
@@ -922,12 +922,14 @@ Not to be called directly, but implicitly by the \link{InsuranceContract} object
Calculate the (linear) interpolation factors for the balance
sheet reserve (Dec. 31) between the yearly contract clowing dates
\subsection{Usage}{
-\if{html}{\out{<div class="r">}}\preformatted{InsuranceTarif$getBalanceSheetReserveFactor(params, years = 1)}\if{html}{\out{</div>}}
+\if{html}{\out{<div class="r">}}\preformatted{InsuranceTarif$getBalanceSheetReserveFactor(method, params, years = 1)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
+\item{\code{method}}{The method for the balance sheet interpolation (30/360, act/act, act/360, act/365 or a function)}
+
\item{\code{params}}{Contract-specific, full set of parameters of the contract
(merged parameters of the defaults, the tariff, the profit participation
scheme and the contract)}
--
GitLab