diff --git a/R/InsuranceTarif.R b/R/InsuranceTarif.R index 5a690afacf9dd0147c333d59e542e24e69e4befa..7ed7c9b4c7e52d3891d258875dac56e198d5503e 100644 --- a/R/InsuranceTarif.R +++ b/R/InsuranceTarif.R @@ -197,7 +197,7 @@ InsuranceTarif = R6Class( #' or mortality table for comparison. There is no need to re-implement a #' tariff for such comparisons, as long as only parameters are changed. #' - #' @param ... Parameters for the [InsuranceContract.Parameterstructure], + #' @param ... Parameters for the [InsuranceContract.ParameterStructure], #' defining the characteristics of the tariff. #' @import MortalityTables #' @examples @@ -236,7 +236,7 @@ InsuranceTarif = R6Class( #' #' @param tariffType An enum specifying the main characteristics of the tarif. #' See [tariffType] - #' @param ... Parameters for the [InsuranceContract.ParametersStructure], + #' @param ... Parameters for the [InsuranceContract.ParameterStructure], #' defining the characteristics of the tariff. #' @import MortalityTables #' @examples diff --git a/R/ProfitParticipation.R b/R/ProfitParticipation.R index c6c2d7c1e857634b5ed3a433aff47753961c61b1..a35c7be1c023ffc25b9336dc9f37e7e69d84a427 100644 --- a/R/ProfitParticipation.R +++ b/R/ProfitParticipation.R @@ -154,7 +154,7 @@ ProfitParticipation = R6Class( }, - #' @description Store all passed parameters in the [Parameters] field + #' @description Store all passed parameters in the [ProfitParticipation$Parameters] field #' @param ... any of the named fields defined in #' [InsuranceContract.ParameterStructure$ProfitParticipation]. All other #' arguments will be ignored @@ -162,8 +162,8 @@ ProfitParticipation = R6Class( self$Parameters = fillFields(self$Parameters, list(...)); }, - #' @description Store all passed functions in the [Functions] field - #' @param ... any of the functions defined in the [Functions] field. All other + #' @description Store all passed functions in the [ProfitParticipation$Functions] field + #' @param ... any of the functions defined in the [ProfitParticipation$Functions] field. All other #' arguments will be ignored setFunctions = function(...) { self$Functions = fillFields(self$Functions, list(...)); @@ -187,7 +187,7 @@ ProfitParticipation = R6Class( #' to the values passed to this method. #' #' @param name The new name for the cloned [ProfitParticipation] object - #' @param ... Parameters for the [InsuranceContract.ParametersStructure], + #' @param ... Parameters for the [InsuranceContract.ParameterStructure], #' defining the characteristics of the tariff. createModification = function(name = NULL, ...) { cloned = self$clone(); @@ -252,7 +252,7 @@ ProfitParticipation = R6Class( #' @description Set up the data.frame containing the profit participation rates #' @param ... additional parameters passed to the profit calculation functions - #' stored in the [Functions] field. + #' stored in the [ProfitParticipation$Functions] field. setupRates = function(params, values, ...) { # 1) Profit scheme or contract provides general company-wide profit rates for some years: # profitRates @@ -364,7 +364,7 @@ ProfitParticipation = R6Class( #' @param profitScenario profit participation values from a previous calculation #' (NULL if profit calculation is to be calculated from the contract inception). #' Values before \code{calculateFrom} will be used from this data.frame. - #' @param ... additional parameters to be passed to [setupRates] + #' @param ... additional parameters to be passed to [ProfitParticipation$setupRates()] getProfitParticipation = function(calculateFrom = 0, profitScenario = NULL, params, values, ...) { waiting = valueOrFunction(params$ProfitParticipation$waitingPeriod, params = params, values = values); if (is.numeric(waiting) && waiting > 0) { diff --git a/man/InsuranceTarif.Rd b/man/InsuranceTarif.Rd index 1974ef3ec8732915feef12d0226d5bc7bb02295d..b41e95fcfaff8beac1a59aa908181b8d2eb5658d 100644 --- a/man/InsuranceTarif.Rd +++ b/man/InsuranceTarif.Rd @@ -195,7 +195,7 @@ Initialize a new tariff object \item{\code{desc}}{A short human-readable description. See \link{InsuranceTarif$desc}} -\item{\code{...}}{Parameters for the \link{InsuranceContract.Parameterstructure}, +\item{\code{...}}{Parameters for the \link{InsuranceContract.ParameterStructure}, defining the characteristics of the tariff.} } \if{html}{\out{</div>}} @@ -269,7 +269,7 @@ create a copy of a tariff with certain parameters changed \item{\code{tariffType}}{An enum specifying the main characteristics of the tarif. See \link{tariffType}} -\item{\code{...}}{Parameters for the \link{InsuranceContract.ParametersStructure}, +\item{\code{...}}{Parameters for the \link{InsuranceContract.ParameterStructure}, defining the characteristics of the tariff.} } \if{html}{\out{</div>}} diff --git a/man/ProfitParticipation.Rd b/man/ProfitParticipation.Rd index ba5108b1d92fdca782a71f4d4f4e829517829313..6dbd719322dc3e2c97308eb9eb8cb434751e4c0e 100644 --- a/man/ProfitParticipation.Rd +++ b/man/ProfitParticipation.Rd @@ -133,7 +133,7 @@ Create a new profit participation scheme \if{html}{\out{<a id="method-setParameters"></a>}} \if{latex}{\out{\hypertarget{method-setParameters}{}}} \subsection{Method \code{setParameters()}}{ -Store all passed parameters in the \link{Parameters} field +Store all passed parameters in the \link{ProfitParticipation$Parameters} field \subsection{Usage}{ \if{html}{\out{<div class="r">}}\preformatted{ProfitParticipation$setParameters(...)}\if{html}{\out{</div>}} } @@ -152,7 +152,7 @@ arguments will be ignored} \if{html}{\out{<a id="method-setFunctions"></a>}} \if{latex}{\out{\hypertarget{method-setFunctions}{}}} \subsection{Method \code{setFunctions()}}{ -Store all passed functions in the \link{Functions} field +Store all passed functions in the \link{ProfitParticipation$Functions} field \subsection{Usage}{ \if{html}{\out{<div class="r">}}\preformatted{ProfitParticipation$setFunctions(...)}\if{html}{\out{</div>}} } @@ -160,7 +160,7 @@ Store all passed functions in the \link{Functions} field \subsection{Arguments}{ \if{html}{\out{<div class="arguments">}} \describe{ -\item{\code{...}}{any of the functions defined in the \link{Functions} field. All other +\item{\code{...}}{any of the functions defined in the \link{ProfitParticipation$Functions} field. All other arguments will be ignored} } \if{html}{\out{</div>}} @@ -190,7 +190,7 @@ create a copy of a profit scheme with certain parameters changed \describe{ \item{\code{name}}{The new name for the cloned \link{ProfitParticipation} object} -\item{\code{...}}{Parameters for the \link{InsuranceContract.ParametersStructure}, +\item{\code{...}}{Parameters for the \link{InsuranceContract.ParameterStructure}, defining the characteristics of the tariff.} } \if{html}{\out{</div>}} @@ -280,7 +280,7 @@ scheme and the contract)} insurance contract, including cash flows, premiums, reserves etc.).} \item{\code{...}}{additional parameters passed to the profit calculation functions -stored in the \link{Functions} field.} +stored in the \link{ProfitParticipation$Functions} field.} } \if{html}{\out{</div>}} } @@ -345,7 +345,7 @@ scheme and the contract)} \item{\code{values}}{Contract values calculated so far (guaranteed component of the insurance contract, including cash flows, premiums, reserves etc.).} -\item{\code{...}}{additional parameters to be passed to \link{setupRates}} +\item{\code{...}}{additional parameters to be passed to \code{\link[=ProfitParticipation$setupRates]{ProfitParticipation$setupRates()}}} } \if{html}{\out{</div>}} }