Add function isRegularPremiumContract

NAMESPACE

@@ -64,6 +64,8 @@ export(fillNAgaps)
 export(filterProfitRates)
 export(head0)
 export(initializeCosts)
+export(isRegularPremiumContract)
+export(isSinglePremiumContract)
 export(makeContractGridDimname)
 export(makeContractGridDimnames)
 export(pad0)

R/HelperFunctions.R

@@ -103,10 +103,7 @@ ProfitComponentsEnum = objectProperties::setMultipleEnum("ProfitComponents",
 
 #' Determine whether a contract (given all parameters) is a single-premium contract or with regular premiums
 #'
-#' The death benefit will be the full sumInsured for the first year after the
-#' deferral period and then decrease linearly to 0 at the end of the policyPeriod.
-#' This can be used with the \code{deathBenefit} parameter for insurance
-#' contracts, but should not be called directly.
+#' Single premium contracts are identified by the parameter \code{premiumPeriod = 1}.
 #'
 #' @param params The parameters of the contract.
 #' @param values Unused by default (already calculated values of the contract)
@@ -115,6 +112,17 @@ ProfitComponentsEnum = objectProperties::setMultipleEnum("ProfitComponents",
 isSinglePremiumContract = function(params, values) { params$ContractData$premiumPeriod <= 1 }
 
 
+#' Determine whether a contract (given all parameters) is a contract with regular premiums
+#'
+#' Regular premium contracts are identified by the parameter \code{premiumPeriod > 1}.
+#'
+#' @param params The parameters of the contract.
+#' @param values Unused by default (already calculated values of the contract)
+#'
+#' @export
+isRegularPremiumContract = function(params, values) { params$ContractData$premiumPeriod > 1 }
+
+
 #' Describes the death benefit of a linearly decreasing whole life insurance (after a possible deferall period)
 #'
 #' The death benefit will be the full sumInsured for the first year after the

man/isRegularPremiumContract.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/HelperFunctions.R
+\name{isRegularPremiumContract}
+\alias{isRegularPremiumContract}
+\title{Determine whether a contract (given all parameters) is a contract with regular premiums}
+\usage{
+isRegularPremiumContract(params, values)
+}
+\arguments{
+\item{params}{The parameters of the contract.}
+
+\item{values}{Unused by default (already calculated values of the contract)}
+}
+\description{
+Regular premium contracts are identified by the parameter \code{premiumPeriod > 1}.
+}

man/isSinglePremiumContract.Rd

@@ -12,8 +12,5 @@ isSinglePremiumContract(params, values)
 \item{values}{Unused by default (already calculated values of the contract)}
 }
 \description{
-The death benefit will be the full sumInsured for the first year after the
-deferral period and then decrease linearly to 0 at the end of the policyPeriod.
-This can be used with the \code{deathBenefit} parameter for insurance
-contracts, but should not be called directly.
+Single premium contracts are identified by the parameter \code{premiumPeriod = 1}.
 }