From 69a862fbea77bdad8c0e5bdf3c410c34ffe1a967 Mon Sep 17 00:00:00 2001
From: Reinhold Kainhofer <reinhold@kainhofer.com>
Date: Wed, 21 Sep 2016 14:33:18 +0000
Subject: [PATCH] Start adding examples to the docs
---
man/ageShift.Rd | 7 +++++++
man/ages.Rd | 7 +++++++
man/baseTable.Rd | 5 +++++
man/baseYear.Rd | 5 +++++
4 files changed, 24 insertions(+)
diff --git a/man/ageShift.Rd b/man/ageShift.Rd
index 7110cf5..ddaed95 100644
--- a/man/ageShift.Rd
+++ b/man/ageShift.Rd
@@ -25,4 +25,11 @@ Return the age shift of the age-shifted life table given the birth year
\item \code{mortalityTable.ageShift}: Return the age shift of the age-shifted life table
given the birth year
}}
+\examples{
+mortalityTables.load("Austria_Annuities")
+ageShift(AVOe2005R.male.av, YOB=1910)
+ageShift(AVOe2005R.male.av, YOB=1955)
+ageShift(AVOe2005R.male.av, YOB=2010)
+
+}
diff --git a/man/ages.Rd b/man/ages.Rd
index 49cccf3..9c147c6 100644
--- a/man/ages.Rd
+++ b/man/ages.Rd
@@ -37,4 +37,11 @@ Return the defined ages of the life table
\item \code{mortalityTable.observed}: Return the defined ages of the observed life table
}}
+\examples{
+mortalityTables.load("Austria_*", wildcard=TRUE)
+ages(AVOe2005R.male)
+ages(AVOe1996R.male)
+ages(mort.AT.census.2011.male)
+
+}
diff --git a/man/baseTable.Rd b/man/baseTable.Rd
index 7011174..4b7dd34 100644
--- a/man/baseTable.Rd
+++ b/man/baseTable.Rd
@@ -27,4 +27,9 @@ Return the base table of the life table
\item \code{mortalityTable.period}: Return the base table of the life table
}}
+\examples{
+mortalityTables.load("Austria_Annuities")
+baseTable(AVOe2005R.male)
+
+}
diff --git a/man/baseYear.Rd b/man/baseYear.Rd
index 059a6ce..281ff4b 100644
--- a/man/baseYear.Rd
+++ b/man/baseYear.Rd
@@ -27,4 +27,9 @@ Return the base year of the life table
\item \code{mortalityTable.mixed}: Return the base year of the life table
}}
+\examples{
+mortalityTables.load("Austria_Annuities")
+baseYear(AVOe2005R.male)
+
+}
--
GitLab