From fa7038ade6a8f90d6cf73e347a303694c6cec355 Mon Sep 17 00:00:00 2001
From: Reinhold Kainhofer <reinhold@kainhofer.com>
Date: Mon, 12 Sep 2016 09:09:49 +0200
Subject: [PATCH] Start adding examples to the function documentation (as
 requested for CRAN)

---
 R/ageShift.R  | 6 ++++++
 R/ages.R      | 7 +++++++
 R/baseTable.R | 4 ++++
 R/baseYear.R  | 4 ++++
 4 files changed, 21 insertions(+)

diff --git a/R/ageShift.R b/R/ageShift.R
index 06bb30f..edefc8b 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 ff9ea3d..1a6c7b5 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 135057b..8197691 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 653ca1b..9f659e6 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"));
 
-- 
GitLab