Start adding examples to the function documentation (as requested for CRAN)

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"));
 

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, ...) {

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"));
 

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"));