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

Docs: Fix typos, broken links and long lines in docstrings

parent aa83c36b
Branches
Tags
No related merge requests found
...@@ -313,7 +313,7 @@ PP.benefit.TerminalBonus5YearsProRata = function(profits, params, ...) { ...@@ -313,7 +313,7 @@ PP.benefit.TerminalBonus5YearsProRata = function(profits, params, ...) {
}; };
#' @describeIn ProfitParticipationFunctions #' @describeIn ProfitParticipationFunctions
#' Terminal bonus is only paid out during the last 5 years of the contract (but never during the first 10 year) #' Terminal bonus is only paid out during the last 5 years of the contract (but never during the first 10 years)
#' @export #' @export
PP.benefit.TerminalBonus5Years = function(profits, params, ...) { PP.benefit.TerminalBonus5Years = function(profits, params, ...) {
n = params$ContractData$policyPeriod; n = params$ContractData$policyPeriod;
......
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
#' function \code{contractGridPremium}. #' function \code{contractGridPremium}.
#' #'
#' The \code{axes} list describing the parameters changing along the axes of the #' The \code{axes} list describing the parameters changing along the axes of the
#' resulting grid is internally expanded with [grid.expand()]. The resulting flat #' resulting grid is internally expanded with [expand.grid()]. The resulting flat
#' list of parameter (together with the fixed parameters passed as \code{...}) #' list of parameter (together with the fixed parameters passed as \code{...})
#' is then passed to the [InsuranceContract$new()] call to create the corresponding #' is then passed to the [InsuranceContract$new()] call to create the corresponding
#' contract object. #' contract object.
...@@ -109,7 +109,8 @@ makeContractGridDimname.default = function(value) { value } ...@@ -109,7 +109,8 @@ makeContractGridDimname.default = function(value) { value }
#' #'
#' makeContractGridDimnames(axes = list( #' makeContractGridDimnames(axes = list(
#' age = seq(30,60,10), #' age = seq(30,60,10),
#' mortalityTable = c(mort.AT.census.2011.unisex, mort.AT.census.2011.male, mort.AT.census.2011.female)) #' mortalityTable = c(mort.AT.census.2011.unisex, mort.AT.census.2011.male,
#' mort.AT.census.2011.female))
#' ) #' )
#' @export #' @export
makeContractGridDimname = function(value) { UseMethod("makeContractGridDimname", value) } makeContractGridDimname = function(value) { UseMethod("makeContractGridDimname", value) }
......
...@@ -243,7 +243,7 @@ the rates and how the assigned profit is calculated. ...@@ -243,7 +243,7 @@ the rates and how the assigned profit is calculated.
\item \code{PP.benefit.TerminalBonus5YearsProRata}: Calculate benefit from terminal bonus as 1/n parts of the terminal bonus reserve during the last 5 years \item \code{PP.benefit.TerminalBonus5YearsProRata}: Calculate benefit from terminal bonus as 1/n parts of the terminal bonus reserve during the last 5 years
\item \code{PP.benefit.TerminalBonus5Years}: Terminal bonus is only paid out during the last 5 years of the contract (but never during the first 10 year) \item \code{PP.benefit.TerminalBonus5Years}: Terminal bonus is only paid out during the last 5 years of the contract (but never during the first 10 years)
\item \code{PP.benefit.TerminalBonus}: Calculate benefit from terminal bonus (full bonus), either old-style terminal bonus reserve or Terminal Bonus Fund (TBF) \item \code{PP.benefit.TerminalBonus}: Calculate benefit from terminal bonus (full bonus), either old-style terminal bonus reserve or Terminal Bonus Fund (TBF)
}} }}
......
...@@ -62,7 +62,7 @@ values to display in a grid. For this feature, one can also use the convenience ...@@ -62,7 +62,7 @@ values to display in a grid. For this feature, one can also use the convenience
function \code{contractGridPremium}. function \code{contractGridPremium}.
The \code{axes} list describing the parameters changing along the axes of the The \code{axes} list describing the parameters changing along the axes of the
resulting grid is internally expanded with \code{\link[=grid.expand]{grid.expand()}}. The resulting flat resulting grid is internally expanded with \code{\link[=expand.grid]{expand.grid()}}. The resulting flat
list of parameter (together with the fixed parameters passed as \code{...}) list of parameter (together with the fixed parameters passed as \code{...})
is then passed to the \code{\link[=InsuranceContract$new]{InsuranceContract$new()}} call to create the corresponding is then passed to the \code{\link[=InsuranceContract$new]{InsuranceContract$new()}} call to create the corresponding
contract object. contract object.
......
...@@ -41,6 +41,7 @@ makeContractGridDimname(mort.AT.census.2011.unisex) ...@@ -41,6 +41,7 @@ makeContractGridDimname(mort.AT.census.2011.unisex)
makeContractGridDimnames(axes = list( makeContractGridDimnames(axes = list(
age = seq(30,60,10), age = seq(30,60,10),
mortalityTable = c(mort.AT.census.2011.unisex, mort.AT.census.2011.male, mort.AT.census.2011.female)) mortalityTable = c(mort.AT.census.2011.unisex, mort.AT.census.2011.male,
mort.AT.census.2011.female))
) )
} }
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment