diff --git a/R/ageShift.R b/R/ageShift.R index 06bb30ff5d0ed968f1e7a5b6b5fe9c29c4c58dac..edefc8be97935267ed4206173ee28f31cc5c8c93 100644 --- a/R/ageShift.R +++ b/R/ageShift.R @@ -7,6 +7,12 @@ NULL #' @param ... Other parameters (currently unused) #' @param YOB The birth year for which the age shift should be determined. #' +#' @examples +#' mortalityTables.load("Austria_Annuities") +#' ageShift(AVOe2005R.male.av, YOB=1910) +#' ageShift(AVOe2005R.male.av, YOB=1955) +#' ageShift(AVOe2005R.male.av, YOB=2010) +#' #' @exportMethod ageShift setGeneric("ageShift", function(object, YOB=1975, ...) standardGeneric("ageShift")); diff --git a/R/ages.R b/R/ages.R index ff9ea3d3edfc523582a8a0080d3ccf8e11d87785..1a6c7b552e9e8d497864afb0ce40bc9ebb8d9e7b 100644 --- a/R/ages.R +++ b/R/ages.R @@ -6,9 +6,16 @@ NULL #' @param object A life table object (instance of a \code{\linkS4class{mortalityTable}} class) #' @param ... Currently unused #' +#' @examples +#' mortalityTables.load("Austria_*", wildcard=TRUE) +#' ages(AVOe2005R.male) +#' ages(AVOe1996R.male) +#' ages(mort.AT.census.2011.male) +#' #' @exportMethod ages setGeneric("ages", function(object, ...) standardGeneric("ages")); + #' @describeIn ages Return the defined ages of the period life table setMethod("ages", "mortalityTable.period", function (object, ...) { diff --git a/R/baseTable.R b/R/baseTable.R index 135057b828d2f87894482c9d961ee8972a2678a7..8197691264932e6061523bf5c70cc3f0ecdfb906 100644 --- a/R/baseTable.R +++ b/R/baseTable.R @@ -6,6 +6,10 @@ NULL #' @param object The life table object (class inherited from mortalityTable) #' @param ... Other parameters (currently unused) #' +#' @examples +#' mortalityTables.load("Austria_Annuities") +#' baseTable(AVOe2005R.male) +#' #' @exportMethod baseTable setGeneric("baseTable", function(object, ...) standardGeneric("baseTable")); diff --git a/R/baseYear.R b/R/baseYear.R index 653ca1b1c93f6b9a8e1fefd29d14a1c7e7da5a0d..9f659e637932f01fd3b07199c837372ff5df2088 100644 --- a/R/baseYear.R +++ b/R/baseYear.R @@ -6,6 +6,10 @@ NULL #' @param object The life table object (class inherited from mortalityTable) #' @param ... Other parameters (currently unused) #' +#' @examples +#' mortalityTables.load("Austria_Annuities") +#' baseYear(AVOe2005R.male) +#' #' @exportMethod baseYear setGeneric("baseYear", function(object, ...) standardGeneric("baseYear"));