R: Modelling Traditional Life Insurance Contracts

# Modelling Traditional Life Insurance Contracts

## Documentation for package ‘LifeInsureR’ version 1.0.1

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

age.exactRounded | Calculate the age of the insured based on exact age at contract closing, rounded to the nearest birthday.
age.yearDifference | Calculate the age of the insured based on the difference of the bith year and contract closing year.
applyHook | If 'hook' is a function, apply it to 'val', otherwise return 'val' unchanged
CalculationEnum | Enum to define how much of a contract needs to be calculated automatically.
CalculationSingleEnum-class | Enum to define how much of a contract needs to be calculated automatically.
contractGrid | Create a grid of InsuranceContract objects or premiums with each axis representing one varying parameter
contractGridPremium | Create a grid of InsuranceContract objects or premiums with each axis representing one varying parameter
costs.baseAlpha | Helper function to define base costs with base alpha, but otherwise unchanged costs
costs.scaleAlpha | Helper function to modify alpha costs of an insurance contract individually
costsDisplayTable | Helper function to display all cost definitions in a concise table
costValuesAsDF | Convert the multi-dimensional costs array to a data.frame for output to a file
deathBenefit.annuityDecreasing | Describes the death benefit of a decreasing whole life insurance (after a possible deferall period)
deathBenefit.linearDecreasing | Describes the death benefit of a linearly decreasing whole life insurance (after a possible deferall period)
exportInsuranceContract.xlsx | Export an insurance contract (object of class InsuranceContract) to an 'Excel' file
exportInsuranceContractExample | Export the example calculations of an insurance contract
fallbackFields | Replace missing values in ields by default fallback values
fillFields | Overwrite all existing fields with default values given
fillNAgaps | Replace all 'NA' entries of a vector with the previous non-NA value
filterProfitRates | Filter the whole data.frame of profit rates for the given profit classes
freqCharge | Defines a frequency charge (surcharge for monthly/quarterly/semiannual) premium payments
getTerminalBonusReserve | Helper functions for profit participation
head0 | Set all entries of the given vector to 0 up until index 'start'
initializeCosts | Initialize or modify a data structure for the definition of InsuranceTarif costs
InsuranceContract | Base Class for Insurance Contracts
InsuranceContract.ParameterDefaults | Default parameters for the InsuranceContract class.
InsuranceContract.ParametersFallback | Use fallback values for missing contract parameters
InsuranceContract.ParametersFill | Initialize the insurance contract parameters from passed arguments
InsuranceContract.ParameterStructure | Full insurance contract parameter structure.
InsuranceContract.Values | Data structure (filled only with NULL) for insurance contract class member values.
InsuranceTarif | Base class for traditional Insurance Tarifs (with fixed guarantee, profit sharing and no unit-linked component)
isRegularPremiumContract | Determine whether a contract (given all parameters) is a contract with regular premiums
isSinglePremiumContract | Determine whether a contract (given all parameters) is a single-premium contract or with regular premiums
makeContractGridDimname | Create human-readable labels for the dimensions in a 'contractGrid()'
makeContractGridDimnames | Create human-readable labels for the dimensions in a 'contractGrid()'
pad0 | Pad a vector with 0 to a desired length
padLast | Pad the vector 'v' to length 'l' by repeating the last entry of the vector.
PaymentTimeEnum | Enum to describe when a benefit or premium payment is due (in advance or in arrears)
PaymentTimeSingleEnum-class | Enum to describe when a benefit or premium payment is due (in advance or in arrears)
PP.base.contractualReserve | Helper functions for profit participation
PP.base.meanContractualReserve | Helper functions for profit participation
PP.base.NULL | Helper functions for profit participation
PP.base.previousContractualReserve | Helper functions for profit participation
PP.base.PreviousZillmerReserve | Helper functions for profit participation
PP.base.sumInsured | Helper functions for profit participation
PP.base.totalProfitAssignment | Helper functions for profit participation
PP.base.ZillmerReserveT2 | Helper functions for profit participation
PP.base.ZillmerRiskPremium | Helper functions for profit participation
PP.benefit.None | Helper functions for profit participation
PP.benefit.Profit | Helper functions for profit participation
PP.benefit.ProfitGuaranteeSupporting | Helper functions for profit participation
PP.benefit.ProfitPlusGuaranteedInterest | Helper functions for profit participation
PP.benefit.ProfitPlusHalfGuaranteedInterest | Helper functions for profit participation
PP.benefit.ProfitPlusHalfInterestMinGuaranteeTotal | Helper functions for profit participation
PP.benefit.ProfitPlusHalfTotalInterest | Helper functions for profit participation
PP.benefit.ProfitPlusInterestMinGuaranteeTotal | Helper functions for profit participation
PP.benefit.ProfitPlusTerminalBonusReserve | Helper functions for profit participation
PP.benefit.ProfitPlusTotalInterest | Helper functions for profit participation
PP.benefit.TerminalBonus | Helper functions for profit participation
PP.benefit.TerminalBonus5Years | Helper functions for profit participation
PP.benefit.TerminalBonus5YearsProRata | Helper functions for profit participation
PP.calculate.RateOnBase | Helper functions for profit participation
PP.calculate.RateOnBaseMin0 | Helper functions for profit participation
PP.calculate.RateOnBaseSGFFactor | Helper functions for profit participation
PP.calculate.RatePlusGuaranteeOnBase | Helper functions for profit participation
PP.rate.expenseProfit | Helper functions for profit participation
PP.rate.interestProfit | Helper functions for profit participation
PP.rate.interestProfit2 | Helper functions for profit participation
PP.rate.interestProfit2PlusGuarantee | Helper functions for profit participation
PP.rate.interestProfitPlusGuarantee | Helper functions for profit participation
PP.rate.riskProfit | Helper functions for profit participation
PP.rate.sumProfit | Helper functions for profit participation
PP.rate.terminalBonus | Helper functions for profit participation
PP.rate.terminalBonusFund | Helper functions for profit participation
PP.rate.totalInterest | Helper functions for profit participation
PP.rate.totalInterest2 | Helper functions for profit participation
premiumRefundPeriod.default | Default premium refund period: for deferred contracts the deferral period, otherwise the whole contract
ProfitComponentsEnum | Enum to define the different components of profit participation.
ProfitComponentsMultipleEnum-class | Enum to define the different components of profit participation.
ProfitParticipation | Base Class for Profit Participation Schemes
ProfitParticipationFunctions | Helper functions for profit participation
PVfactory | PVfactory (R6Class for present values with arbitrary dimensions)
rollingmean | Calculate the rolling mean of length 2
RoundingHelper | Helper object to define rounding rules for the InsuranceContract, InsuranceTarif and ProfitParticipation classes.
setCost | Update one component of an InsuranceTarif's cost structure
SexEnum | Enum to describe possible sexes in an insurance contract or tariff.
SexSingleEnum-class | Enum to describe possible sexes in an insurance contract or tariff.
showVmGlgExamples | Display insurance contract calculation example
sumProfits | Helper functions for profit participation
TariffTypeEnum | An enum specifying the main characteristics of the tarif.
TariffTypeSingleEnum-class | An enum specifying the main characteristics of the tarif.
testVmGlgExample | Perform unit tests of given standard values of the insurance contract example
valueOrFunction | If 'val' is a function, evaluate it, otherwise return 'val'
vmGlgExample.generateTest | Generate testthat output for unit-testing a tarif implementation