Framework for Traditional Life Insurance Contracts


[Up] [Top]

Documentation for package ‘LifeInsuranceContracts’ version 0.0.3

Help Pages

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
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 act object tocontract (object of class InsuranceContract) to an Excel file
exportInsuranceContractExample Export the example calculations of an insurance contract
fallbackFields Replace all missing values in fields (either missing or NA) with their corresponding values from fallback. Members in fallback that are missing in fields are inserted
fillFields Overwrite all existing fields in the first argument with values given in valuelist. Members of valuelist that are not yet in fields are ignored. This allows a huge valuelist to be used to fill fields in multiple lists with given structure.
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 #' Tariffs are typically calculated with yearly premium installments. When premiums are paid more often then one a year (in advance), the insurance receives part of the premium later (or not at all in case of death), so a surcharge for premium payment frequencies higher than yearly is applied to the premium, typically in the form of a percentage of the premium.
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. A new contract will be pre-filled with these values, and values passed in the constructor (or with other setter functions) will override these values.
InsuranceContract.ParametersFallback InsuranceContract.ParametersFallback
InsuranceContract.ParametersFill InsuranceContract.ParametersFill
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
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
rollingmean Calculate the rolling mean of length 2
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. Possible values are: annuity Whole life or term annuity (periodic survival benefits) with flexible payouts (constand, increasing, decreasing, arbitrary, etc.) wholelife A whole or term life insurance with only death benefits. The benefit can be constant, increasing, decreasing, described by a function, etc. endowment An endowment with death and survival benefits, potentially with different benefits. pureendowment A pure endowment with only a survival benefit at the end of the contract. Optionally, in case of death, all or part of the premiums paid may be refunded. terme-fix A terme-fix insurance with a fixed payout at the end of the contract, even if the insured dies before that time. Premiums are paid until death of the insured. dread-disease A dread-disease insurance, which pays in case of a severe illness (typically heart attacks, cancer, strokes, etc.), but not in case of death. endowment + dread-disease A combination of an endowment and a temporary dread-disease insurance. Benefits occur either on death, severe illness or survival, whichever comes first.
TariffTypeSingleEnum-class An enum specifying the main characteristics of the tarif. Possible values are: annuity Whole life or term annuity (periodic survival benefits) with flexible payouts (constand, increasing, decreasing, arbitrary, etc.) wholelife A whole or term life insurance with only death benefits. The benefit can be constant, increasing, decreasing, described by a function, etc. endowment An endowment with death and survival benefits, potentially with different benefits. pureendowment A pure endowment with only a survival benefit at the end of the contract. Optionally, in case of death, all or part of the premiums paid may be refunded. terme-fix A terme-fix insurance with a fixed payout at the end of the contract, even if the insured dies before that time. Premiums are paid until death of the insured. dread-disease A dread-disease insurance, which pays in case of a severe illness (typically heart attacks, cancer, strokes, etc.), but not in case of death. endowment + dread-disease A combination of an endowment and a temporary dread-disease insurance. Benefits occur either on death, severe illness or survival, whichever comes first.
valueOrFunction If 'val' is a function, evaluate it, otherwise return 'val'