Skip to content
Snippets Groups Projects
Commit 47c3bca3 authored by Reinhold Kainhofer's avatar Reinhold Kainhofer
Browse files

Re-generate docs

parent 7dc4bc8b
Branches Costs
Tags
No related merge requests found
...@@ -41,6 +41,9 @@ for single-premium contracts. ...@@ -41,6 +41,9 @@ for single-premium contracts.
contracts with multiple parts, e.g. dynamic increases), contracts with multiple parts, e.g. dynamic increases),
default = "Hauptvertrag"} default = "Hauptvertrag"}
\item{\code{$sumInsured}}{Sum insured, default = 100,000} \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 \item{\code{$YOB}}{Year of birth of the insured, used to determine the
age for the application of the mortality table} age for the application of the mortality table}
\item{\code{$age}}{Age of the insured} \item{\code{$age}}{Age of the insured}
...@@ -144,7 +147,15 @@ are calculated. Value of type \link{Date}, typically generated with ...@@ -144,7 +147,15 @@ are calculated. Value of type \link{Date}, typically generated with
month are relevant.} month are relevant.}
\item{\code{$balanceSheetMethod}}{How to interpolate the balance sheet \item{\code{$balanceSheetMethod}}{How to interpolate the balance sheet
reserves (at the balandeSheetDate) from the yearly contractual 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.} 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 \item{\code{$surrenderValueCalculation}}{A function describing the surrender
value calculation.} value calculation.}
\item{\code{$premiumFrequencyOrder}}{Order of the approximation for \item{\code{$premiumFrequencyOrder}}{Order of the approximation for
......
...@@ -559,6 +559,7 @@ Calculate all time series of the contract from the parameters ...@@ -559,6 +559,7 @@ Calculate all time series of the contract from the parameters
valuesFrom = 0, valuesFrom = 0,
premiumCalculationTime = 0, premiumCalculationTime = 0,
preservePastPV = TRUE, preservePastPV = TRUE,
additionalCapital = 0,
recalculatePremiums = TRUE, recalculatePremiums = TRUE,
recalculatePremiumSum = TRUE, recalculatePremiumSum = TRUE,
history_comment = NULL, history_comment = NULL,
...@@ -590,6 +591,10 @@ they no longer represent the actual contract state at these ...@@ -590,6 +591,10 @@ they no longer represent the actual contract state at these
times. If values are not recalculated, the reserves at each times. If values are not recalculated, the reserves at each
time step represent the proper state at that point in time.} 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 \item{\code{recalculatePremiums}}{Whether the premiums should be recalculated
at time \code{premiumCalculationTime} at all.} at time \code{premiumCalculationTime} at all.}
......
...@@ -922,12 +922,14 @@ Not to be called directly, but implicitly by the \link{InsuranceContract} object ...@@ -922,12 +922,14 @@ Not to be called directly, but implicitly by the \link{InsuranceContract} object
Calculate the (linear) interpolation factors for the balance Calculate the (linear) interpolation factors for the balance
sheet reserve (Dec. 31) between the yearly contract clowing dates sheet reserve (Dec. 31) between the yearly contract clowing dates
\subsection{Usage}{ \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}{ \subsection{Arguments}{
\if{html}{\out{<div class="arguments">}} \if{html}{\out{<div class="arguments">}}
\describe{ \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 \item{\code{params}}{Contract-specific, full set of parameters of the contract
(merged parameters of the defaults, the tariff, the profit participation (merged parameters of the defaults, the tariff, the profit participation
scheme and the contract)} scheme and the contract)}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment