diff --git a/NAMESPACE b/NAMESPACE index 76f5fefdfeb18a74811b43bfee323b06f4c6dee7..f47086667a0be7df2288ac39c18cd8e50beeff7e 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -12,6 +12,7 @@ export(mT.extrapolateTrendExp) export(mT.fillAges) export(mT.fitExtrapolationLaw) export(mT.getDimInfo) +export(mT.getName) export(mT.scaleProbs) export(mT.setDimInfo) export(mT.setName) diff --git a/R/utilityFunctions.R b/R/utilityFunctions.R index aee3282dcb2d561882888bf66fb9825d3291a05e..388771c0f0e020f5ba090629354a667e380bd032 100644 --- a/R/utilityFunctions.R +++ b/R/utilityFunctions.R @@ -108,6 +108,32 @@ mT.setName = function(table, name) { table } +#' Retrieves the name of the given mortality table or the list/table/array of mortalityTables +#' +#' @param table A life table object (instance of a \code{mortalityTable} class) or a list, table or array of mortalityTable objects +#' +#' @examples +#' mortalityTables.load("Austria_Annuities") +#' mT.getName(AVOe2005R.male) +#' +#' @export +mT.getName = function(table) { + if (is.array(table)) { + return(array( + lapply(table, mT.getName), + dim = dim(table), dimnames = dimnames(table)) + ) + } else if (is.list(table)) { + return(lapply(table, mT.getName)) + } else if (is.na(c(table))) { + return(table) + } + if (!is(table, "mortalityTable")) + stop("First argument must be a mortalityTable or a list of mortalityTable objects.") + + table@name +} + #' Restrict/expand a mortalityTable to certain ages #' diff --git a/man/mT.getName.Rd b/man/mT.getName.Rd new file mode 100644 index 0000000000000000000000000000000000000000..55ad6711ed5d322932d7dc88034f4a7673b9dd10 --- /dev/null +++ b/man/mT.getName.Rd @@ -0,0 +1,19 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/utilityFunctions.R +\name{mT.getName} +\alias{mT.getName} +\title{Retrieves the name of the given mortality table or the list/table/array of mortalityTables} +\usage{ +mT.getName(table) +} +\arguments{ +\item{table}{A life table object (instance of a \code{mortalityTable} class) or a list, table or array of mortalityTable objects} +} +\description{ +Retrieves the name of the given mortality table or the list/table/array of mortalityTables +} +\examples{ +mortalityTables.load("Austria_Annuities") +mT.getName(AVOe2005R.male) + +}