From 32aa1f67f7ca50fc5fc1ed9de26d26e7015a190e Mon Sep 17 00:00:00 2001
From: Reinhold Kainhofer <reinhold@kainhofer.com>
Date: Thu, 28 Oct 2021 21:42:44 +0200
Subject: [PATCH] Docu fixes
---
R/InsuranceParameters.R | 3 ++-
man/InsuranceContract.ParametersFill.Rd | 2 +-
man/costsDisplayTable.Rd | 3 +++
3 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/R/InsuranceParameters.R b/R/InsuranceParameters.R
index 5962a9c..02291f0 100644
--- a/R/InsuranceParameters.R
+++ b/R/InsuranceParameters.R
@@ -168,6 +168,7 @@ costs.baseAlpha = function(alpha) {
#'
#' Returns a data.frame with columns
#'
+#' @param costs The cost structure to be displayed in a concise table style.
#' @export
costsDisplayTable = function(costs) {
costtable = as.data.frame.table(setInsuranceValuesLabels(costs) )
@@ -617,7 +618,7 @@ InsuranceContract.ParameterStructure$Loadings["premiumFrequencyLoading"] = list(
#' structure is given, an empty (i.e. all NULL entries) structure is used.
#'
#' @param params Initial values of the insurance contract parameters. (default: empty parameter structure)
-#' @param costs,... Values for any of the entries in the insurance contract
+#' @param costs,minCosts,... Values for any of the entries in the insurance contract
#' parameter structure. These values take precedence over the
#' initial parameters provided in \code{params}.
#'
diff --git a/man/InsuranceContract.ParametersFill.Rd b/man/InsuranceContract.ParametersFill.Rd
index e3fcb09..118a423 100644
--- a/man/InsuranceContract.ParametersFill.Rd
+++ b/man/InsuranceContract.ParametersFill.Rd
@@ -14,7 +14,7 @@ InsuranceContract.ParametersFill(
\arguments{
\item{params}{Initial values of the insurance contract parameters. (default: empty parameter structure)}
-\item{costs, ...}{Values for any of the entries in the insurance contract
+\item{costs, minCosts, ...}{Values for any of the entries in the insurance contract
parameter structure. These values take precedence over the
initial parameters provided in \code{params}.}
}
diff --git a/man/costsDisplayTable.Rd b/man/costsDisplayTable.Rd
index 784a6be..684111c 100644
--- a/man/costsDisplayTable.Rd
+++ b/man/costsDisplayTable.Rd
@@ -6,6 +6,9 @@
\usage{
costsDisplayTable(costs)
}
+\arguments{
+\item{costs}{The cost structure to be displayed in a concise table style.}
+}
\description{
Returns a data.frame with columns
}
--
GitLab