From 704a2571dbe06be884f2fe8c37940d941be3bdb8 Mon Sep 17 00:00:00 2001
From: Reinhold Kainhofer <reinhold@kainhofer.com>
Date: Wed, 2 Sep 2020 02:16:55 +0200
Subject: [PATCH] Docs: Fix typos, broken links and long lines in docstrings
---
R/ProfitParticipation_Functions.R | 2 +-
R/contractGrid.R | 5 +++--
man/ProfitParticipationFunctions.Rd | 2 +-
man/contractGrid.Rd | 2 +-
man/makeContractGridDimname.Rd | 3 ++-
5 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/R/ProfitParticipation_Functions.R b/R/ProfitParticipation_Functions.R
index c53790f..5a47242 100644
--- a/R/ProfitParticipation_Functions.R
+++ b/R/ProfitParticipation_Functions.R
@@ -313,7 +313,7 @@ PP.benefit.TerminalBonus5YearsProRata = function(profits, params, ...) {
};
#' @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
PP.benefit.TerminalBonus5Years = function(profits, params, ...) {
n = params$ContractData$policyPeriod;
diff --git a/R/contractGrid.R b/R/contractGrid.R
index e1042f1..4e7f16c 100644
--- a/R/contractGrid.R
+++ b/R/contractGrid.R
@@ -21,7 +21,7 @@
#' function \code{contractGridPremium}.
#'
#' 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{...})
#' is then passed to the [InsuranceContract$new()] call to create the corresponding
#' contract object.
@@ -109,7 +109,8 @@ makeContractGridDimname.default = function(value) { value }
#'
#' makeContractGridDimnames(axes = list(
#' 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
makeContractGridDimname = function(value) { UseMethod("makeContractGridDimname", value) }
diff --git a/man/ProfitParticipationFunctions.Rd b/man/ProfitParticipationFunctions.Rd
index 7b53f37..2b2910d 100644
--- a/man/ProfitParticipationFunctions.Rd
+++ b/man/ProfitParticipationFunctions.Rd
@@ -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.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)
}}
diff --git a/man/contractGrid.Rd b/man/contractGrid.Rd
index f851541..5242691 100644
--- a/man/contractGrid.Rd
+++ b/man/contractGrid.Rd
@@ -62,7 +62,7 @@ values to display in a grid. For this feature, one can also use the convenience
function \code{contractGridPremium}.
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{...})
is then passed to the \code{\link[=InsuranceContract$new]{InsuranceContract$new()}} call to create the corresponding
contract object.
diff --git a/man/makeContractGridDimname.Rd b/man/makeContractGridDimname.Rd
index da97d4d..1787609 100644
--- a/man/makeContractGridDimname.Rd
+++ b/man/makeContractGridDimname.Rd
@@ -41,6 +41,7 @@ makeContractGridDimname(mort.AT.census.2011.unisex)
makeContractGridDimnames(axes = list(
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))
)
}
--
GitLab